Hace poco tiempo que me topé casi por casualidad con FlatDoc y la verdad es que me causó curiosidad. Descargué rápidamente el proyecto para probarlo y la verdad es que me sorprendió muy positivamente. No solo es increíblemente fácil de utilizar, si no que también tiene un diseño moderno y bonito, el cual es completamente personalizable.
Utilización
Para comenzar crearemos un archivo basado en la plantilla que se nos ofrece, el cual cargará todos los scripts necesarios automáticamente desde GitHub, así como el tema básico.
Dependiendo de el lugar en donde tengamos nuestros archivos MarkDown usaremos una función para cargar el contenido u otra. En el ejemplo nos viene lo siguiente:
Flatdoc.run({
fetcher: Flatdoc.github('USUARIO/REPOSITORIO')
});De esta forma FlatDoc obtendrá los archivos del repositorio de GitHub que le indiquemos. Si queremos cargar los archivos desde una carpeta podrémos hacerlo de la siguiente manera:
Flatdoc.run({
fetcher: Flatdoc.file('Readme.md')
});
Flatdoc.run({
fetcher: Flatdoc.file('http://yoursite.com/Readme.md')
});Viene todo perfectamente explicado en la página principal, la cual hace uso del propio proyecto para mostrar la documentación y es un perfecto ejemplo del mismo. También podéis encontrar más información en el repositorio de GitHub.
Recordad que la plantilla es tan solo un ejemplo, y hay muchas más opciones que podéis utilizar. Tan solo probad a cambiar el código para ver lo que pasa :)