TwoDragonLake organization official project docs archive

Introduction

Document summary,use mkdocs build

• Preview
• Mkdocs
• Theme

Project Branch Structure

tdl-saas-archive
    ├── gh-pages      	# automatic web source code
    └── master			# source code (edit branch)

Preparation

Installing Python

python --version
Python 3.7.2
pip --version
pip 18.1

MkDocs supports Python versions 2.7, 3.3, 3.4, 3.5 and pypy.

Installing MkDocs

pip install mkdocs

Installing Theme

pip install mkdocs-material

Contribution

# Get code
git clone https://github.com/TwoDragonLake/tdl-saas-archive.git
cd tdl-saas-archive
# run preview
mkdocs serve
# new docs (create a new file in the corresponding directory)，eg：new-docs.md
# add docs index (Page tree)
vim mkdocs.yml
# commit
git commit -m "eg:specific contents"
# push
git push

Appendix

• about manual deployment
• Automatically build related
• Automatically build related

License

© TwoDragonLake, 2018. Licensed under an Apache-2 license.