You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
113 lines
8.1 KiB
113 lines
8.1 KiB
<section data-type="chapter">
|
|
<h1>Quick Start Guide</h1>
|
|
|
|
<p>Atlas is currently in its Beta release; this means that, while we feel the system is ready to be used, it's still actively under development and needs some rigorous testing. That's where you come in! Here are the most important things you need to know to get started.</p>
|
|
|
|
<section data-type="sect1">
|
|
<h1>Atlas (Beta Release) Is Built on Git</h1>
|
|
|
|
<p>Atlas is built on <a data-original-title="" href="http://git-scm.com" title="">Git</a>, the powerful version control system that tracks every change in your content, who made it, and when it happened. What this means is that your content is secure and can be rolled back to any previous version if necessary. Git also provides the functionality for seamless collaboration tools.</p>
|
|
</section>
|
|
|
|
<section data-type="sect1">
|
|
<h1>Your Projects</h1>
|
|
|
|
<p>When you sign into Atlas, <strong>the first thing you'll see is a list of all your existing projects</strong>. If you want to edit or build from an existing project, simply find and click the project in the list. To <strong>create a new project</strong>, click the New Project button to the right of the projects list.</p>
|
|
|
|
<figure><img alt="Alt Text" class="icontentsimagesnewprojpng" src="images/newproj.png" />
|
|
<figcaption>Click the New Project button in your project list to start fresh.</figcaption>
|
|
</figure>
|
|
|
|
<p>If you want to start from scratch, you can define the title and description for your project and choose a project template to pre-populate your new repository with some skeleton files based on the kind of project you’re making.</p>
|
|
|
|
<p>You can also create a new Atlas project by importing an existing project from GitHub.</p>
|
|
|
|
<p>Once you select a project or create a new one, <strong>you'll be taken to the project dashboard</strong>, where you'll see a list of all files in the project, and have access to the <a data-type="xref" href="#building_in_atlas" title="">ebook-building tools</a>.</p>
|
|
</section>
|
|
|
|
<section data-type="sect1">
|
|
<h1>The Project Dashboard</h1>
|
|
|
|
<p><strong>The project dashboard is your landing page for each project.</strong> It lists all the files and folders in your project, specifies your active branch, and gives you quick access to the build tools (more on building <a data-type="xref" href="#building_in_atlas">below</a>). You can also navigate from here to the Project Settings and Activity pages.</p>
|
|
|
|
<p>From the project dashboard, <strong>click a file in the Files pane at left to open it in the editor.</strong></p>
|
|
</section>
|
|
|
|
<section data-type="sect1">
|
|
<h1>Writing and Editing</h1>
|
|
|
|
<p><strong>The Atlas editor has two writing modes</strong>: the Visual Editor and the Code Editor. The Visual Editor is an online authoring environment similar to a word processor, with a formatting toolbar for tagging and styling your content. Documents created in the Visual Editor are stored as <a href="http://oreillymedia.github.io/HTMLBook/">HTMLBook</a>, a specification of <a href="http://en.wikipedia.org/wiki/HTML5">HTML5</a>. The Code Editor allows you to view and edit the underlying HTML5 markup for your document. You can toggle back and forth between the Visual and Code Editors, and changes you make in either mode will immediately be reflected in the other.</p>
|
|
|
|
<p>While <strong>HTML5 is the default markup language for Atlas content</strong>, Atlas also supports documents written in<strong> <a data-original-title="" href="https://help.github.com/articles/github-flavored-markdown" title="">Markdown</a>, <a href="http://www.methods.co.nz/asciidoc/">AsciiDoc</a>, and <a data-original-title="" href="http://www.docbook.org/" title="">DocBook XML</a></strong>. All three of these formats can be edited using the Code Editor.</p>
|
|
|
|
<p>In both writing modes, you can <strong>navigate among your files using the Files menu</strong> to the left of the screen, <strong>create and delete files and folders</strong>, <strong>upload images</strong>, <strong>save your project</strong> (specify a custom commit message by clicking on the dropdown arrow next to the Save button), and even <strong>initiate builds</strong>.</p>
|
|
</section>
|
|
|
|
<section data-type="sect1">
|
|
<h1>Creating a New File</h1>
|
|
|
|
<p>To create a new file, click the New File button at bottom of the dashboard. Give your file a name, and press Enter. You can also do this in the Files pane in the editor.</p>
|
|
|
|
<p>You can also organize your files into folders. To add a folder, click the New Folder button (next to the New File button). You can then click the folder name in the Files menu to open the folder and create new files within it.</p>
|
|
|
|
<div data-type="warning">
|
|
<h1>Warning</h1>
|
|
|
|
<p>You can't currently organize your files within Atlas. If you want to move existing files into a folder, you need to do that outside of Atlas using Git.</p>
|
|
</div>
|
|
</section>
|
|
|
|
<section data-type="sect1" id="building_in_atlas">
|
|
<h1>Building</h1>
|
|
|
|
<p>When you're finished writing, it's time to build your project so you can share it with the world. <strong>Atlas lets you export your project in four different formats</strong>: PDF, EPUB, MOBI, and HTML website.</p>
|
|
|
|
<p>Before you build for the first time, you'll need to choose which files from your project to include and the settings you want to apply to each format; <strong>click Configure</strong> on the project dashboard.</p>
|
|
|
|
<p>In the Files section, simply <strong>choose files from the left-hand pane to add to the build</strong>, and drag the files into the correct order on the right. You can remove files from the build list by clicking on the minus button.</p>
|
|
|
|
<p>Each format has a few different configuration options. Four are common to all formats:</p>
|
|
|
|
<ul>
|
|
<li>Create a <strong>table of contents</strong> in your output, based on your section headings.</li>
|
|
<li>Collect all index tags you've added and create an <strong>alphabetical index</strong> in your final format.</li>
|
|
<li>Apply <strong>syntax highlighting</strong> to language-specific code sections in build output.</li>
|
|
<li>Display or suppress <strong>Atlas comments</strong> in build output (HTMLBook only).</li>
|
|
</ul>
|
|
|
|
<p>Finally, choose a theme for your project. You can pick from one of the available default themes, or specify your own custom theme.</p>
|
|
|
|
<p>Click Save, and now you can build from the dashboard.</p>
|
|
|
|
<figure><img alt="Alt Text" class="icontentsimagesquickbuildspng" src="images/quickbuilds.png" />
|
|
<figcaption>The Builds menu on the project dashboard allows you to quickly trigger a build using your previously chosen settings.</figcaption>
|
|
</figure>
|
|
|
|
<p>If the build is successful, you'll get a link to download the file. If it fails, you'll get information about what went wrong (the usual culprit is markup errors).</p>
|
|
</section>
|
|
|
|
<section data-type="sect1">
|
|
<h1>Themes and Design</h1>
|
|
|
|
<p>All of the Atlas output formats (PDF, EPUB, MOBI, and HTML) are powered by <a href="http://en.wikipedia.org/wiki/Cascading_Style_Sheets">CSS</a>, the standard styling language for the Web. You can write an entirely new theme using CSS that can be used for multiple projects, by multiple people, or you can just add CSS customizations for your specific project.</p>
|
|
|
|
<p><strong>To apply a theme to your project</strong>, choose one of the default themes on the Configure page, or add a link to your own custom theme.</p>
|
|
|
|
<figure><img alt="Alt Text" class="icontentsimagesthemepng" src="images/theme.png" />
|
|
<figcaption>Add a design to your project on the Configure page.</figcaption>
|
|
</figure>
|
|
</section>
|
|
|
|
<section data-type="sect1">
|
|
<h1>Building Locally with the API</h1>
|
|
|
|
<p>Atlas gives you the option to <strong>build locally on the command line</strong>, using our <a href="http://docs.atlas.oreilly.com/ch11.html#atlas-api">API</a>. (Note that you'll still need an internet connection for this to work.) This is great if you prefer to work locally using your own text editor but still want to see the final output.</p>
|
|
</section>
|
|
|
|
<section data-type="sect1">
|
|
<h1>Finding Help</h1>
|
|
|
|
<p>For more details on any of the above topics, or for more advanced information, <strong><a data-original-title="" href="https://atlas.oreilly.com/help" title="">visit the Atlas help and support page</a></strong>.</p>
|
|
</section>
|
|
</section>
|