Skip to content

mc-ksjet/hwm-guide-mkdocs-test

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Unofficial Homeworld Mobile Unofficial Guide

This site is build using mkdocs and mkdocs-material

Installation

pip install mkdocs-material mdx_truly_sane_lists mkdocs-git-revision-date-localized-plugin --update

For full documentation visit mkdocs-material.

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/
    css/
        extra.css  # Additional CSS to apply
    img/           # Images
    index.md       # The documentation homepage.
    ...            # Other markdown pages, images and other files.

About

Testing out using mkdocs as an alterative

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published