Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
MyShaarli/mkdocs.yml

55 lines
2.1 KiB
YAML
Raw Normal View History

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
2017-01-26 18:52:54 +01:00
site_name: Shaarli Documentation
repo_url: https://github.com/shaarli/Shaarli
documentation: set edit_uri Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-01 19:10:14 +02:00
edit_uri: edit/master/doc/md
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
2017-01-26 18:52:54 +01:00
site_description: The personal, minimalist, super-fast, database free, bookmarking service
theme: readthedocs
docs_dir: doc/md
site_dir: doc/html
Disable MkDocs' strict mode for ReadTheDocs builds to pass Relates to https://github.com/shaarli/Shaarli/issues/1179 See: - https://www.mkdocs.org/user-guide/configuration/#build-directories - https://github.com/rtfd/readthedocs.org/issues/4314 Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-07-24 23:55:09 +02:00
# Disable strict mode until ReadTheDocs provides up-to-date MkDocs settings:
# - https://github.com/shaarli/Shaarli/issues/1179
# - https://github.com/rtfd/readthedocs.org/issues/4314
# strict: true
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
2017-01-26 18:52:54 +01:00
pages:
- Home: index.md
- Setup:
- Download and Installation: Download-and-Installation.md
- Upgrade and migration: Upgrade-and-migration.md
- Server configuration: Server-configuration.md
- Server security: Server-security.md
- Shaarli configuration: Shaarli-configuration.md
- Plugins: Plugins.md
- Docker:
docker: remove `dev` image, update documentation Relates to https://github.com/shaarli/Shaarli/issues/843 Changed: - Update Docker image list - Update Docker documentation structure Removed: - Delete Dockerfile and resources for the `dev` image - Cleanup `doc/` resources Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-07-29 15:26:27 +02:00
- Docker 101: docker/docker-101.md
- Shaarli images: docker/shaarli-images.md
- Reverse proxy configuration: docker/reverse-proxy-configuration.md
- Docker resources: docker/resources.md
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
2017-01-26 18:52:54 +01:00
- Usage:
- Browsing and searching: Browsing-and-searching.md
doc: merge all sharing methods under a single "Sharing content" page * formatting, wording, reordering, general improvements * move blog/pastebin/notepad item from index.md to this page * add TODOs * add the new page to mkdocs TOC Part of https://github.com/shaarli/Shaarli/issues/598
2018-02-07 20:10:05 +01:00
- Sharing content: Sharing-content.md
Run MkDocs in strict mode Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-06-26 22:21:53 +02:00
- RSS feeds: RSS-feeds.md
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
2017-01-26 18:52:54 +01:00
- REST API: REST-API.md
mkdocs.yml: move FAQ to top level, reorder, Move Community/related software to Usage
2017-12-26 18:44:14 +01:00
- Community & Related software: Community-&-Related-software.md
Docs: rename 'How-to' section to 'Guides' Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-07-01 12:27:55 +02:00
- Guides:
Docs: Add an installation guide for Debian 9 + Docker Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-07-01 16:02:35 +02:00
- Install Shaarli on Debian 9 with Docker: guides/install-shaarli-with-debian9-and-docker.md
Docs: rename 'How-to' section to 'Guides' Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-07-01 12:27:55 +02:00
- Backup, restore, import and export: guides/backup-restore-import-export.md
- Various hacks: guides/various-hacks.md
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
2017-01-26 18:52:54 +01:00
- Development:
- Development guidelines: Development-guidelines.md
- Continuous integration tools: Continuous-integration-tools.md
- GnuPG signature: GnuPG-signature.md
- Directory structure: Directory-structure.md
Add Link structure page to the documentation
2018-03-31 12:39:43 +02:00
- Link Structure: Link-structure.md
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
2017-01-26 18:52:54 +01:00
- 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
Translation documentation
2017-09-01 18:47:32 +02:00
- Translations: Translations.md
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
2017-01-26 18:52:54 +01:00
- Theming: Theming.md
- Unit tests: Unit-tests.md
docker: add alpine,debian,ubuntu test images Relates to https://github.com/shaarli/Shaarli/issues/843 Added: - Makefile target to run commands in a Docker test context - Docker images to run Shaarli test suites: - Alpine 3.6 - Debian 8 - Debian 9 - Ubuntu 16.04 - Documentation Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-05-30 23:45:17 +02:00
- Unit tests inside Docker: Unit-tests-Docker.md
mkdocs.yml: move FAQ to top level, reorder, Move Community/related software to Usage
2017-12-26 18:44:14 +01:00
- FAQ: FAQ.md
- Troubleshooting: Troubleshooting.md
Reference in a new issue Copy permalink