Name: fixie
Owner: 10up
Description: Fixie is a WordPress theme for displaying readable and navigable documentation.
Created: 2013-06-02 21:32:16.0
Updated: 2017-05-15 22:11:58.0
Pushed: 2013-06-17 16:59:09.0
Homepage: null
Size: 46639
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
Fixie is a WordPress theme for displaying readable and navigable documentation.
Fixed gear bicycles, or “fixies” are stripped down and simple machines, a bicycle in the purest form. Simplicity means an easy to use and understand experience. Single page Fixie docs were conceived by Brandon Phillips as a response to the sea of document trees, toggle arrows, and docs spread out across thousands of pages.
Fixie docs are displayed as a single page for the reader and maintained as parent->child pages in the admin. Automatic navigation, section breaks, and the browser's native search function allows a reader to move throughout the document easily. Love your scrollbar.
There is not a huge feature set in Fixie; you won't find a 'theme options' page. Instead, we've decided to focus narrowly on documentation and those who read it.
Fixie creates a navigation menu for direct children of the current page. Grandchildren are currently not accounted for in any way.
Revision history for each section of a document is shown on the front-end including when it was last revised and by whom. You can switch out revisions of a section on the fly.
Pages have excerpts and those excerpts are pulled into the margin as marginalia. It should probably be used as the tl;dr for that section.
Images are great visual reference, but can often get in the way and bloat the length of documents. We collapse tall images inline automatically.
Fixie comes with a print stylesheet. Save as PDF and distribute like a boss.
Fixie is a theme and only a theme. The plan is to create several plugins that complement nicely.
Fixie is all about page hierarchy. Each top level page represents a document. In fact, it's visually represented as a book on the home page by it's featured image. Child pages are automatically included into a long, 'fixie' document with the page title acting as a linked header reference.
For more information on how this works and what the HTML structure looks like, you'll want to refer to fixie's documentation, but the assumption is that you break your document up into sections. Each section is a page. Each page has a title and possibly some H2s?H6s.
Fixie should be installed on a new installation, or on a site that has only pages (and is intended to be used as documentation). We remove the post editor from the admin menu, and don't support much of the template hierarchy.