Commit e1317224 authored by Georgios Bitzes's avatar Georgios Bitzes
Browse files

Add mkdocs skeleton with Material theme

parent 64093cca
Pipeline #1497384 failed with stages
in 21 minutes and 53 seconds
......@@ -4,3 +4,4 @@ _book/
.vscode
*.sublime-project
*.sublime-workspace
mkdocs/site
......@@ -8,6 +8,17 @@ stages:
before_script:
- export GTEST_COLOR="1"
make-docs:
stage: build
image: fedora:latest
script:
- dnf install -y mkdocs
- cd mkdocs
- mkdocs build
artifacts:
paths:
- mkdocs/site
c8:
stage: build
image: gitlab-registry.cern.ch/eos/quarkdb/build-image-c8
......
......@@ -13,3 +13,6 @@
[submodule "deps/asio"]
path = deps/asio
url = https://github.com/chriskohlhoff/asio
[submodule "deps/mkdocs-material"]
path = deps/mkdocs-material
url = https://github.com/squidfunk/mkdocs-material.git
Subproject commit dc5d86d52e380fa0ec558a616992143312de0a65
# Welcome to MkDocs
For full documentation visit [mkdocs.org](https://mkdocs.org).
## Commands
* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs help` - Print this help message.
## Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
site_name: QuarkDB Documentation
theme:
name: null
custom_dir: '../deps/mkdocs-material/material'
language: en
# 404 page
static_templates:
- 404.html
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
# Default values, taken from mkdocs_theme.yml
language: en
feature:
tabs: true
palette:
primary: indigo
accent: indigo
font:
text: Roboto
code: Roboto Mono
favicon: assets/images/favicon.png
logo:
icon: "\uE80C"
palette:
font:
text: Roboto
code: Roboto Mono
logo:
icon: "\uE80C"
feature:
tabs: true
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment