Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
2662 commits 8 branches 1 tag 12 MiB
Commit graph

14 commits

Author SHA1 Message Date
nodiscc
484ee2bbb0
tool/.gitattributes: exclude doc/html/.doctrees/ from zip exports 
- https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-d
- https://stackoverflow.com/questions/33904042/is-doctrees-folder-required-for-displaying-html-docs-with-sphinx
 2023-10-06 12:33:01 +02:00
nodiscc
db1532214e
replace mkdocs with sphinx/myst-parser for HTML documentation generation 
- fixes https://github.com/shaarli/Shaarli/issues/1451
- tools/.gitattributes: exclude doc/conf.py and doc/requirements.txt from zip exports
- tools/doc/sphinx: suppress myst.xref_missing warnings caused by https://github.com/executablebooks/MyST-Parser/issues/564
- dockerfile: use makefile/sphinx instead of mkdocs to build HTML documentation
- dockerfile: add bash to the docs build container (make: bash: No such file or directory)
- tools/doc/readthedocs: force use of python 3.11 (readthedocs ERROR: No matching distribution found for sphinx==7.1.0)
- tools/doc/readthedocs: add all required configuration variables https://docs.readthedocs.io/en/latest/config-file/v2.html#build-os
- tools/doc/readthedocs: override build commands to allow the source directory to be different from the conf.py directory (https://docs.readthedocs.io/en/stable/config-file/v2.html#build-commands, https://github.com/readthedocs/readthedocs.org/issues/1543)
- tools/doc/readthedocs: manually set output directory (readthedocs ERROR: No _readthedocs/html folder was created during this build.)
- doc: replace all references to mkdocs with sphinx
 2023-10-05 15:01:34 +02:00
VirtualTam
81c801300b Provide a Docker Compose example 
Closes https://github.com/shaarli/Shaarli/issues/1010

See:
- https://hub.docker.com/_/traefik/
- https://docs.traefik.io/configuration/backends/docker/
- https://docs.traefik.io/user-guide/docker-and-lets-encrypt/
- https://github.com/containous/traefik/pull/2798
- https://github.com/containous/traefik/issues/3298

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2018-07-12 21:48:48 +02:00
VirtualTam
2a3fe990dd docker: build the images from the local sources 
Relates to https://github.com/shaarli/Shaarli/issues/1153

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2018-06-17 01:02:50 +02:00
ArthurHoaro
03b483aa45 Add SASSLint makefile target, and run it in CI 
Also move ESLint and SASSLint config files to a dedicated .dev folder
 2018-05-10 13:29:47 +02:00
ArthurHoaro
47978e8772 Webpack / Configure webpack, ESLint, Travis, Makefile, npm/yarn and git 2018-03-28 19:04:40 +02:00
ArthurHoaro
d637976329 Use makefile target to generate MO file and remove it from git 2017-10-22 12:56:55 +02:00
VirtualTam
e9619cc4f8 Add EditorConfig configuration 
EditorConfig allows specifying indentation, line feed and encoding
properties according to the type of file being edited.

Most editors support it out-of-the-box, or can benefit from it through a
plugin.

See:
- http://editorconfig.org/
- https://github.com/editorconfig/editorconfig
- https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2017-10-11 21:35:17 +02:00
nodiscc
53ed6d7d1e 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-06-18 00:19:49 +02:00
ArthurHoaro
07b57cfef9 Prevent git from messing with font files 
This should remove font related errors in browser debig consoles
 2017-03-09 19:41:32 +01:00
VirtualTam
3ee5c69777 Add an AUTHORS file, simplify COPYING, bump year to 2017 
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>
 2017-01-07 14:49:39 +01:00
VirtualTam
b039a061eb Fix: keep composer.json in release archives 
Relates to https://github.com/shaarli/Shaarli/issues/607

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2016-08-12 22:02:59 +02:00
VirtualTam
453f4653c3 Docker: move Dockerfiles to the main repository 
Relates to #420

Fixes:
- [all] remove Nginx' 'server_name' attribute
- [dev] create the phpinfo() script from the Dockerfile

Modifications:
- [all] remove documentation/guide (to be added to the wiki)
- [all] update maintainer information
- [prod] differentiate 'master' (:latest) and 'stable' (:stable) images

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2016-01-02 19:01:33 +01:00
VirtualTam
c6a7972de5 Add a .gitattributes to ease repository management 
Features:
- enforce LF (Unix) line endings
- omit dev/test resources & code from Git(Hub) archives
- treat minified resources (CSS, JS) as binaries to avoid cluttered diffs

Resources:
- http://git-scm.com/docs/gitattributes
- https://git-scm.com/book/en/v2/Customizing-Git-Git-Attributes
- https://help.github.com/articles/dealing-with-line-endings/
- http://adaptivepatchwork.com/2012/03/01/mind-the-end-of-your-line/
- https://github.com/Danimoth/gitattributes

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2015-12-23 23:40:15 +01:00