This Is A New Project¶

SECTION 1: Introduction¶

Congratulations! If you can see this file you have probably successfully run the runestone init command. If you are looking at this as a source file you should now run runestone build to generate html files. Once you have run the build command you can run runestone serve and then view this in your browser at http://localhost:8000

This is just a sample of what you can do. The index.rst file is the table of contents for your entire project. You can put all of your writing in the index, or you can include additional rst files. Those files may even be in subdirectories that you can reference using a relative path.

.. toctree::
   :maxdepth: 2

   some/path/myfile.rst

Section 2: Links¶

Runestone uses the restructuredText (rst) markup language. We chose this over markdown largely because rst is extensible. Nearly all of the basic markup tasks are already handled by restructuredText. You should check out the docs for the basics of restructuredText (link below). Our extensions are all for the interactive elements. One key hint about restructuredText: Its like Python – indentation matters!

• restructuredText Docs
• Runestone Docs
• Join the discussion on our Google Group
• Tell us about problems on Github

SECTION 3: Sample Directives¶