From 0513faafd4a91dc9e557113c6a145a3fca16274b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sim=C3=B3=20Albert=20i=20Beltran?= Date: Mon, 22 Feb 2021 15:43:07 +0100 Subject: [PATCH] MkDocs+Gitlab setup --- .gitignore | 1 + .gitlab-ci.yml | 4 ++++ README.md | 5 +++++ docs/index.md | 3 +++ mkdocs.yml | 22 ++++++++++++++++++++++ requirements.txt | 2 ++ 6 files changed, 37 insertions(+) create mode 100644 .gitignore create mode 100644 .gitlab-ci.yml create mode 100644 README.md create mode 100644 docs/index.md create mode 100644 mkdocs.yml create mode 100644 requirements.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a48cf0d --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +public diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..6815e49 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,4 @@ +include: + - project: 'pages/mkdocs' + ref: 'master' + file: '/.gitlab-ci.yml' diff --git a/README.md b/README.md new file mode 100644 index 0000000..f64e552 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# DigitalDemocratic Documentation + +This documentation is writed in Markdown using [MkDocs+Gitlab](https://gitlab.com/pages/mkdocs). + +See `docs` directory for Markdown files or the [auto-built site](https://digitaldemocratic.gitlab.io/digitaldemocratic). diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..39d4700 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ +# Welcome + +This site is built by [MkDocs+Gitlab](https://gitlab.com/pages/mkdocs). You can [browse its source code](https://gitlab.com/digitaldemocratic/digitaldemocratic). diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..ed220b5 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,22 @@ +site_name: DigitalDemocratic Documentation +site_dir: public +repo_url: https://gitlab.com/digitaldemocratic/digitaldemocratic + +theme: + name: material + features: + - toc.integrate + +plugins: + - search + - enumerate-headings + - i18n: + languages: + ca: "Català" + es: "Castellano" + en: "English" + default_language: 'en' + no_translation: + ca: "Aquesta pàgina no està traduida al català." + en: "This page isn't translated to English." + es: "Esta página no está traducida al castellano." diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..3a9704d --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +mkdocs-i18n +mkdocs-enumerate-headings-plugin