All Downloads are FREE. Search and download functionalities are using the official Maven repository.

ru.vyarus.gradle.plugin.mkdocs.template.init.docs.index.md Maven / Gradle / Ivy

There is a newer version: 4.0.1
Show newest version
# Welcome to MkDocs

* [mkdocs documentation](http://mkdocs.org).
* [mkdocs-material documentation](https://squidfunk.github.io/mkdocs-material/).

## Project layout

    mkdocs.yml    # The configuration file.
    docs/
        index.md  # The documentation homepage.
        ...       # Other markdown pages, images and other files.

## Gradle tasks

* `mkdocsInit` - Create new mkdocs site (like this).
* `mkdocsBuild` - Build the documentation site.
* `mkdocsServe` - Start the live-reloading docs server.
* `mkdocsPublish` - Publish generated site version to github pages.

## Mkdocs native 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.




© 2015 - 2025 Weber Informatics LLC | Privacy Policy