From 53ed6d7d1e678d7486337ce67a2f17b30bac21ac Mon Sep 17 00:00:00 2001 From: nodiscc Date: Thu, 26 Jan 2017 18:52:54 +0100 Subject: Generate HTML documentation using MkDocs (WIP) MkDocs is a static site generator geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML file. * http://www.mkdocs.org/ * http://www.mkdocs.org/user-guide/configuration/ Ref. #312 * remove pandoc-generated HTML documentation * move markdown doc to doc/md/, * mkdocs.yml: * generate HTML doc in doc/html * add pages TOC/ordering * use index.md as index page * Makefile: remove execute permissions from generated files * Makefile: rewrite htmlpages GFM to markdown conversion using sed: awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks * Add mkdocs.yml to .gitattributes, exclude this file from release archives * Makefile: rename: htmldoc -> doc_html target * run make doc: pull latest markdown documentation from wiki * run make htmlpages: update html documentation --- mkdocs.yml | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 mkdocs.yml (limited to 'mkdocs.yml') diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..f9648a7e --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,53 @@ +site_name: Shaarli Documentation +repo_url: https://github.com/shaarli/Shaarli +site_description: The personal, minimalist, super-fast, database free, bookmarking service +theme: readthedocs +docs_dir: doc/md +site_dir: doc/html + +pages: +- Home: index.md +- Setup: + - Download and Installation: Download-and-Installation.md + - Upgrade and migration: Upgrade-and-migration.md + - Server requirements: Server-requirements.md + - Server configuration: Server-configuration.md + - Server security: Server-security.md + - Shaarli configuration: Shaarli-configuration.md + - Plugins: Plugins.md +- Docker: + - Docker 101: Docker-101.md + - Shaarli images: Shaarli-images.md + - Reverse proxy configuration: Reverse-proxy-configuration.md + - Docker resources: Docker-resources.md +- Usage: + - Features: Features.md + - Bookmarklet: Bookmarklet.md + - Browsing and searching: Browsing-and-searching.md + - Firefox share: Firefox-share.md + - RSS feeds: RSS-feeds.md + - REST API: REST-API.md +- How To: + - Backup, restore, import and export: Backup,-restore,-import-and-export.md + - Copy an existing installation over SSH and serve it locally: Copy-an-existing-installation-over-SSH-and-serve-it-locally.md + - Create and serve multiple Shaarlis (farm): Create-and-serve-multiple-Shaarlis-(farm).md + - Download CSS styles from an OPML list: Download-CSS-styles-from-an-OPML-list.md + - Datastore hacks: Datastore-hacks.md +- Troubleshooting: Troubleshooting.md +- Development: + - Development guidelines: Development-guidelines.md + - Continuous integration tools: Continuous-integration-tools.md + - GnuPG signature: GnuPG-signature.md + - Coding guidelines: Coding-guidelines.md + - Directory structure: Directory-structure.md + - 3rd party libraries: 3rd-party-libraries.md + - Plugin System: Plugin-System.md + - Release Shaarli: Release-Shaarli.md + - Versioning and Branches: Versioning-and-Branches.md + - Security: Security.md + - Static analysis: Static-analysis.md + - Theming: Theming.md + - Unit tests: Unit-tests.md +- About: + - FAQ: FAQ.md + - Community & Related software: Community-&-Related-software.md -- cgit v1.2.3 From 460ce50115e5f5a1183c3c410fd76636ee5c4716 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sun, 18 Jun 2017 06:29:15 +0200 Subject: doc: rename "datastore hacks" -> "various hacks", move example scripts to gist.github.com, remove obsolete GH wiki _Sidebar.md --- mkdocs.yml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) (limited to 'mkdocs.yml') diff --git a/mkdocs.yml b/mkdocs.yml index f9648a7e..d6dd3fc2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -29,10 +29,7 @@ pages: - REST API: REST-API.md - How To: - Backup, restore, import and export: Backup,-restore,-import-and-export.md - - Copy an existing installation over SSH and serve it locally: Copy-an-existing-installation-over-SSH-and-serve-it-locally.md - - Create and serve multiple Shaarlis (farm): Create-and-serve-multiple-Shaarlis-(farm).md - - Download CSS styles from an OPML list: Download-CSS-styles-from-an-OPML-list.md - - Datastore hacks: Datastore-hacks.md + - Various hacks: Various-hacks.md - Troubleshooting: Troubleshooting.md - Development: - Development guidelines: Development-guidelines.md -- cgit v1.2.3