Skip to content
Snippets Groups Projects
Commit 6bbe8589 authored by Daniele Ingrassia's avatar Daniele Ingrassia
Browse files

added basic mkdocs template

parent bc8b3131
No related branches found
No related tags found
No related merge requests found
.env
_site
.DS_Store
image: python:3.8-slim
before_script:
# install Git for the mkdocs revision plugin
- time apt update && apt-get install -y git
# Install mkdocs and theme
- time pip install -r requirements.txt
test:
stage: test
script:
- time mkdocs build --site-dir test
artifacts:
paths:
- test
except:
- master
pages:
stage: deploy
variables:
GIT_DEPTH: 1000
script:
- time mkdocs build --site-dir public
artifacts:
paths:
- public
only:
- master
<link href="main.css" rel="stylesheet"></link>
this is a test
added with visual studio code
# Open Lab Starter Kit
......
# Home
# Home
# Home
# Home
# Home
# Home
# Home
# Replace the text below to customize your site
site_name: Open Lab Starter Kit
site_description: Documentation site for the OLSK machines
site_author: OLSK Team
copyright: Creative Commons Attribution-ShareAlike 4.0
site_url:
extra:
social:
# For other social icons at https://squidfunk.github.io/mkdocs-material/setup/adding-social-links/
- icon:
link:
- icon:
link:
- icon:
link:
- icon:
link:
theme:
name: material
palette:
# try other colors https://squidfunk.github.io/mkdocs-material/getting-started/#primary-colors
primary: amber
accent: indigo
font:
# See available fonts at https://fonts.google.com/
text: Ubuntu
code: Ubuntu Mono
icon:
logo: material/school
favicon: images/favicon.svg
features:
- navigation.tabs
- navigation.instant
plugins:
- search
- git-revision-date-localized:
fallback_to_build_date: true
markdown_extensions:
- extra
- smarty
- admonition
- codehilite:
guess_lang: false
- toc:
permalink: true
type something here
\ No newline at end of file
# Documentation static site generator
mkdocs >=1.1.2, ==1.1.*
mkdocs-git-revision-date-localized-plugin ~= 0.8.0
# Add your custom theme if not inside a theme_dir
# (https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes)
mkdocs-material ~= 6.2
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment