https://github.com/runemadsen/atlas-book-sample2
https://github.com/runemadsen/atlas-book-sample2
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/runemadsen/atlas-book-sample2
- Owner: runemadsen
- Created: 2013-07-10T19:12:38.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2013-07-22T13:36:37.000Z (almost 12 years ago)
- Last Synced: 2025-04-01T21:51:55.618Z (3 months ago)
- Size: 59.6 KB
- Stars: 2
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Atlas Book Sample
=================
This repository holds a basic project skeleton that can be built through O'Reilly Atlas. We fork this repository whenever you create a new project in the Atlas UI, which means that you can also just fork it directly on GitHub when starting a new book.
Follow this README to learn more about the basic skeleton of an Atlas book.
atlas.json
----------
An Atlas repository must have a file called `atlas.json` in the repository root. This file is used to hold project metadata, the most important being the files to build.
Content
-------
The Atlas build system tries not to enforce strict rules on the way you write your content. That being said, here's a few things to keep in mind:
* You can write in normal HTML, Markdown, or Asciidoc. Allowed file extensions are: `.html`, `.md`, `.markdown`, `.asc`, and `.asciidoc`
* Markdown and Ascidoc will be compiled into HTMLBook..... MORE
* Each file must be or compile to valid HTML. The content `
Hello` is not a valid file, but `
Hello
` is.
* You can have files in any subfolder, as long as you specify the relative path to the folder in the `files` array.