跳转至

README

欢迎你来到我的网站， 该网站是静态网站，主要内容是日常工作学习中的一些技术笔记和博客文章，使用Markdown格式编写， 通过Mkdocs构建项目文档 （mkdocs.org），最终通过Github Action部署在Github Pages上

下面分别介绍了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

Text Only
1
2
3
4
mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

material-theme

在该主题中，以下内容可做参考 - Note

Markdown
1
2
!!! note
    This is a note.
举例， 以下命令同理

Note

this is a note

  • Tip

    Markdown
    1
2
    !!! tip
    This is a tip.

  • Warning

    Markdown
    1
2
    !!! warning
    This is a warning.

  • Danger

    Markdown
    1
2
    !!! danger
    This is a danger.

  • Success

    Markdown
    1
2
    !!! success
    This is a success.

  • Info
    Markdown
    1
2
    !!! info
    This is an info.
  • Quote
    Markdown
    1
2
    !!! quote
    This is a quote.
  • Question
    Markdown
    1
2
    ??? question "What is the meaning of life, the universe, and everything?"
    42.