-
Notifications
You must be signed in to change notification settings - Fork 213
Editing this Wiki
Robert Jacob edited this page Aug 3, 2016
·
19 revisions
-
Wiki pages can be edited either through the web page (like a wiki) or via a clone of the repository https://github.com/ESMCI/cime.wiki.git (editing source code with your favorite text editor and using git commands to update)
-
Pages should be named with dashes between words. The page name will be rendered without dashes.
-
Editing through the web interface
- When creating a new page, be sure to select reStructuredText from the Edit mode: dropdown.
-
Editing with a git clone.
- When creating a new page with a text editor, use the .rest file suffix
- New pages go under the "source" subdirectory of the main subdirectory. This is for building pdfs with Sphinx.
- If someone using the web interface created a new page, it will be in the top level directory. Please move it.
- If someone changed the name of a file with the web interface, it will be in the top level directory. Please move it.
-
If adding a new page which should be at the top level, add it to the sidebar (which must be done via git clone.)
-
To learn more about using reStructuredText and Sphinx, see the Getting Started page.