Skip to content

Commit

Permalink
shrink the images
Browse files Browse the repository at this point in the history
  • Loading branch information
cjsheets committed Mar 12, 2018
1 parent 9219db5 commit ac9f3aa
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ assuming a flat file structure.
### File Structure

Right now, your documentation can only use the first two file levels. I'm working on
adding support for a 3rd level of file nesting.
adding support for a 3rd level.

![Code structure](docs/img/level-example.png)

Expand All @@ -50,24 +50,27 @@ will be a category containing the pages nested under it (ex. Instructions which

### Collapsing

The dropdown menu is



## Default Settings

Both ReadTheDocs and MkDocs use a "long-page" document structure. There is no nesting of pages. See [user-guide/instructions/](http://readthedocs.sheets.ch/user-guide/instructions/) as an example.

Collapsing is based on top-level headings in each page.
The dropdown menu is controlled by heading levels.

```
# Page Title <-- Top level heading
# Page Title <-- H1
content, content, content
## Section <-- H2
### Section <-- H3
```

The rules for headings are essentially:

* If there is only one H1, it will be ignored and the page/file name will be the root dropdown element
* Having 2 sub-menus with no choices was a wierd experience
* See [MkDocs](http://readthedocs.sheets.ch/) for an example
* If there are multiple H1, they each become dropdown elements
* See [user-guide/instructions](http://readthedocs.sheets.ch/user-guide/instructions/) for an example

There is currently no support for H3+ dropdowns. I'm working on adding support to the next version.


Considerations
Expand All @@ -79,7 +82,6 @@ Considerations
For further discussion, see [this issue](https://github.com/mkdocs/mkdocs/issues/588#issuecomment-341931422).



Development
-----------

Expand Down
Binary file modified docs/img/level-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/output-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ac9f3aa

Please sign in to comment.