docs: Add a very basic mkdocs setup
ci/woodpecker/push/build Pipeline was successful Details

This commit is contained in:
Sameer Rahmani 2023-05-18 00:43:19 +01:00
parent cd1c675b51
commit db58f73d7c
Signed by: lxsameer
GPG Key ID: B0A4AF28AB9FD90B
3 changed files with 97 additions and 0 deletions

17
docs/index.md Normal file
View File

@ -0,0 +1,17 @@
# Welcome to MkDocs
For full documentation visit [mkdocs.org](https://www.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 -h` - Print help message and exit.
## Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.

View File

@ -1 +1,3 @@
mkdocs-material
mike
mkdocs-git-revision-date-localized-plugin

78
mkdocs.yml Normal file
View File

@ -0,0 +1,78 @@
site_name: Serene Programming Language
repo_url: https://devheroes.codes/serene/serene
repo_name: Serene
copyright: Copyright © 2019 - 2023 Sameer Rahmani
edit_uri: edit/master/docs/
theme:
name: material
logo: /img/logo.png
favicon: images/favicon.png
icon:
repo: fontawesome/brands/git-alt
edit: material/pencil
view: material/eye
features:
- content.action.edit
- navigation.tracking
- navigation.instant
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.expand
- navigation.indexes
- toc.follow
- toc.integrate
- navigation.top
- search.suggest
- search.highlight
- search.share
- header.autohide
- navigation.footer
palette:
# Palette toggle for light mode
- scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
primary: deep purple
accent: amber
# Palette toggle for dark mode
- scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
primary: deep purple
accent: amber
plugins:
- git-revision-date-localized:
enable_creation_date: true
- search
# - social:
# concurrency: 16
- tags
- mike:
# These fields are all optional; the defaults are as below...
alias_type: symlink
redirect_template: null
deploy_prefix: ''
canonical_version: null
version_selector: true
css_dir: css
javascript_dir: js
extra:
version:
provider: mike
social:
- icon: fontawesome/brands/mastodon
link: https://social.lxsameer.com/@lxsameer
generator: false