Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 815 Bytes

README.md

File metadata and controls

28 lines (18 loc) · 815 Bytes

Welcome to BNB Chain Knowledge Base

This is the BNB Chain Knowledge Base documentation for the BNB Chain developers. It is based on the Mkdocs Material theme.

Prerequisite

  • pip install mkdocs-material - install mkdocs-material.
  • pip install mkdocs-video - install mkdocs-video.
  • pip install mkdocs-redirects - install mkdocs-redirects plugin.

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.

📜 License

Copyright (c) 2024 BNB Chain