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
Added:
- AUTHORS file listing Shaarli contributors
- mailmap information to group a Git author's different aliases
- Makefile target to list contributors from Git commit data
Changed:
- Simplify COPYING by using a single "Shaarli Community" entry
- Bump year to 2017
See:
- man git-shortlog
- https://www.kernel.org/pub/software/scm/git/docs/git-shortlog.html#_mapping_authors
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
Relates to #607
Archive creation process (tar, zip):
- let Composer resolve functional (no-dev) dependencies
- call git-archive to generate a release archive
- include 3rd-party dependencies to the generated archive
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
Additions:
- [makefile] check versioned files are not executable
- [travis] call the new make target
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
Relates to #95
Customizations for PHP/Shaarli:
- add project information
- index PHP files
- index global functions
- exclude directories
Usage
$ make doxygen
$ firefox doxygen/index.html &
Notes
- classes can be found under "Data Structures"
- global functions can be found under "Files > Globals > Functions"
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
Closes#291Fixes#227
Modifications
- HTML content: match the new Wiki structure
- Makefile
- generate a custom HTML sidebar
- include the sidebar on all pages
- infer and prepend page titles
- handle relative links
- add title metadata, e.g. Shaarli - <Page Name>
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
Relates to #95
Usage
- list available standards
$ ./vendor/bin/phpcs -i
- run PHPCS against a given standard
$ make PHPCS_<standard>
Examples
$ make PHPCS_PSR1
$ make PHPCS_Zend
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* sync current wiki (https://github.com/shaarli/Shaarli/wiki) to the doc/ directory
* fix missing logo in README
* add link to local documentation in the page footer
* add Makefile targets for doc generation by @virtualtam
