Skip to content

Commit

Permalink
docs: improve index.md and fix mkdocs.yml to work with mike
Browse files Browse the repository at this point in the history
  • Loading branch information
Michele-Alberti committed Nov 12, 2024
1 parent 1896fc2 commit 1194220
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 21 deletions.
23 changes: 11 additions & 12 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
# Welcome to MkDocs
# Welcome to Data-Lunch documentation!

For full documentation visit [mkdocs.org](https://www.mkdocs.org).
>**Data-Lunch:**
>
>The ultimate web app for a well organized lunch.
## Commands
**Data-Lunch** is your best friends when it's vital to collect and administer lunch orders
for a group of people (wether they are friends or teammates).

* `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.
It started as a small personal project and it quickly became an unrepleaceable companion for me and my colleagues.

## Project layout
## More info

mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
!!! warning "Work in Progress"

More info are coming!
39 changes: 30 additions & 9 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,25 +1,41 @@
# MAIN DATA -------------------------------------------------------------------
# Site data
site_name: Data-Lunch
site_url: "http://Michele-Alberti.github.io/data-lunch/"
site_author: Michele Alberti

# Repository
repo_name: Michele-Alberti/data-lunch
repo_url: https://github.com/Michele-Alberti/data-lunch
edit_uri: ""

# Navigation bar
nav:
- Getting Started: getting_started.md
- Code Reference: reference/

# THEME -----------------------------------------------------------------------
# Theme
theme:
name: "material"
logo: assets/logo-dark.png
favicon: assets/favicon.ico
palette:
scheme: dlunch
extra:
version:
provider: mike
default: stable
alias: true

# Custom colors
extra_css:
- stylesheets/extra.css

nav:
- Getting Started: getting_started.md
- Code Reference: reference/
# PLUGINS AND MARKDOWN EXTENSIONS ---------------------------------------------
# Docs versioning (mike)
extra:
version:
provider: mike
default: stable
alias: true

# Plugins
plugins:
- gh-admonitions
- search
Expand Down Expand Up @@ -53,7 +69,12 @@ plugins:
show_signature_annotations: true
signature_crossrefs: true

# Extensions
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.superfences
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg

0 comments on commit 1194220

Please sign in to comment.