rstacruz/flatdoc — an open-source project — sits at 2.7k GitHub stars. Build sites fast from Markdown
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Flatdoc is a small JavaScript file that fetches Markdown files and renders them
as full pages. Essentially, it's the easiest
way to make open source documentation from Readme files.
No server-side components
No build process needed
Deployable via GitHub Pages
Can fetch GitHub Readme files
Gorgeous default theme (and it's responsive)
Just create an HTML file and deploy!
Current version: v0.9.0
Getting started
Create a file based on the template, which has a bare DOM, link to the
scripts, and a link to a theme. It will look something like this (not exact).
For GitHub projects, simply place this file in your GitHub pages branch and
you're all good to go.
In short: just download this file and upload it somewhere.
The main JS and CSS files are also available in npm and bower.
Default theme template >
Blank template >
Via GitHub
To fetch a Github Repository's readme file, use the Flatdoc.github fetcher.
This will fetch the Readme file of the repository's default branch.
Flatdoc is a hosted .js file (along with a theme and its assets) that you can
add into any page hosted anywhere.
All client-side
There are no build scripts or 3rd-party services involved. Everything is done in
the browser. Worried about performance? Oh, It's pretty fast.
Flatdoc utilizes the GitHub API to fetch your project's Readme files. You may
also configure it to fetch any arbitrary URL via AJAX.
Lightning-fast parsing
Next, it uses marked, an extremely fast Markdown parser that has support for
GitHub flavored Markdown.
Flatdoc then simply renders menu and content DOM elements to your HTML
document. Flatdoc also comes with a default theme to style your page for you, or
you may opt to create your own styles.
Markdown extras
Flatdoc offers a few harmless, unobtrusive extras that come in handy in building
documentation sites.
Code highlighting
You can use Markdown code fences to make syntax-highlighted text. Simply
surround your text with three backticks. This works in GitHub as well.
See GitHub Syntax Highlighting for more info.
``` html
<strong>Hola, mundo</strong>
```
Blockquotes
Blockquotes show up as side figures. This is useful for providing side
information or non-code examples.
Blockquotes are blocks that begin with >.
Smart quotes
Single quotes, double quotes, and double-hyphens are automatically replaced to
their typographically-accurate equivalent. This, of course, does not apply to
<code> and <pre> blocks to leave code alone.
"From a certain point onward there is no longer any turning back. That is the
point that must be reached."
--Franz Kafka
Buttons
If your link text has a > at the end (for instance: Continue >), they show
up as buttons.
View in GitHub >
Customizing
Basic
Theme options
For the default theme (theme-white), You can set theme options by adding
classes to the <body> element. The available options are:
big-h3
Makes 3rd-level headings bigger.
<body class='big-h3'>
no-literate
Disables "literate" mode, where code appears on the right and content text
appear on the left.
<body class='no-literate'>
large-brief
Makes the opening paragraph large.
<body class='large-brief'>
Adding more markup
You have full control over the HTML file, just add markup wherever you see fit.
As long as you leave role='flatdoc-content' and role='flatdoc-menu' empty as
they are, you'll be fine.
Here are some ideas to get you started.
Add a CSS file to make your own CSS adjustments.
Add a 'Tweet' button on top.
Add Google Analytics.
Use CSS to style the IDs in menus (#acknowledgements + p).
JavaScript hooks
Flatdoc emits the events flatdoc:loading and flatdoc:ready to help you make
custom behavior when the document loads.
$(document).on('flatdoc:ready', function() {
// I don't like this section to appear
$("#acknowledgements").remove();
});
Full customization
You don't have to be restricted to the given theme. Flatdoc is just really one
.js file that expects 2 HTML elements (for menu and content). Start with
the blank template and customize as you see fit.
Get blank template >
Misc
Inspirations
The following projects have inspired Flatdoc.
Backbone.js - Jeremy's projects have always adopted this "one page
documentation" approach which I really love.
Docco - Jeremy's Docco introduced me to the world of literate programming,
and side-by-side documentation in general.
Stripe - Flatdoc took inspiration on the look of their API documentation.
DocumentUp - This service has the same idea but does a hosted readme
parsing approach.
Attributions
Photo taken from Flickr,
licensed under Creative Commons.
TopGit's last sync did not record any GitHub topics for rstacruz/flatdoc. GitHub topics appear in the right sidebar of a repository page; that's the authoritative place to check.
How active is development on rstacruz/flatdoc?
The most recent commit recorded on rstacruz/flatdoc was 3.5 years ago, based on the GitHub push timestamp. The repository has 255 forks — one of the better signals of community interest.
How many stars does rstacruz/flatdoc have?
rstacruz/flatdoc has 2.7k GitHub stars — refresh the page for the live number, or check github.com/rstacruz/flatdoc. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What is rstacruz/flatdoc?
rstacruz/flatdoc (rstacruz/flatdoc) is a CSS project on GitHub. From the project's own README: Build sites fast from Markdown
What language is rstacruz/flatdoc written in?
rstacruz/flatdoc is written primarily in CSS. GitHub's language field is based on the largest share of bytes in the default branch.
Read full README in the tab above.
Still deciding about flatdoc?
One click hands the question to an AI along with this page — see what it says about flatdoc.