diff options
| author | Connor Shea <connor.james.shea@gmail.com> | 2016-11-17 10:26:15 +0300 |
|---|---|---|
| committer | Connor Shea <connor.james.shea@gmail.com> | 2016-11-17 10:26:15 +0300 |
| commit | 0e66f0e09e8c1b1926be363f11954a2bce952271 (patch) | |
| tree | 53263ffcc99ca83a43e5316b79d2772f10599d58 /README.md | |
| parent | 0a6f372af1c92dfef5681e5e88c547c65aeaf7fb (diff) | |
Update README. [ci skip]
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 4 |
1 files changed, 2 insertions, 2 deletions
@@ -54,10 +54,10 @@ To pull down the documentation content, run `rake pull_repos`. If you want to fo - [ ] Some way to embed/package the site inside the Rails app so the documentation can be included with the application itself. This would be nice for users behind firewalls, etc. This _should not_ be handled by Rails itself, as that causes all kinds of problems. It should just be a set of static pages. - [ ] Some way to export the documentation as PDF/ePub for use offline. - [ ] Future-proofing for internationalization. -- [ ] Tests for working internal links and such. (Nanoc includes this by default!) +- [x] Tests for working internal links and such. (Nanoc includes this by default!) - [ ] A blog post explaining how we do all this using GitLab, GitLab CI, and GitLab Pages, as well as (almost all?) open source tools. - [x] Breadcrumbs for navigating between pages. -- [ ] Auto-generated Table of Contents for every page. +- [x] Auto-generated Table of Contents for every page. - [ ] Anchor links for every page section. - [x] Syntax highlighting with Rouge. - [ ] Auto-generated documentation structure based on YML frontmatter. |