reStructuredText(.rst) && read the docs

 

Read the Docs   &&  reStructuredText (.rst)  && markdown

 

 

1. github master 分支，创建 docs/index.rst

2. 使用 .rst 语法，设置索引的 title,index,links,url(html..)

 

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71

Home  Page of Blogs Docs ========================   Original Authors =============== * xgqfrms   ## /home/docs/checkouts/readthedocs.org/user_builds/xgqfrms-blogs/checkouts/latest/index.rst      ******      Welcome to Read the Docs    This is an autogenerated index file.    Please create a     /home/docs/checkouts/readthedocs.org/user_builds/xgqfrms-blogs/checkouts/latest/index.rst  or       /home/docs/checkouts/readthedocs.org/user_builds/xgqfrms-blogs/checkouts/latest/README.rst file with your own content.    If you want to use another markup, choose a different builder in your settings.     Contents:   .. toctree::    :maxdepth: 2    :caption: User Documentation      getting-started    howitworks    websecurity   .. toctree::    :maxdepth: 2    :caption: Configuration      config-examples    authenticators    spawners    troubleshooting   .. toctree::    :maxdepth: 1    :caption: Developer Documentation         api/index     .. toctree::    :maxdepth: 1    :caption: Community documentation       .. toctree::    :maxdepth: 2    :caption: About JupyterHub      changelog   .. toctree::    :maxdepth: 1    :caption: Questions? Suggestions?      xgqfrms mailing list <https://groups.google.com/forum/#!forum/xgqfrms>    xgqfrms website <https://xgqfrms.xyz>    Stack Overflow - xgqfrms <https://stackoverflow.com/questions/tagged/xgqfrms>    Stack Overflow - xgqfrms-notebook <https://stackoverflow.com/questions/tagged/xgqfrms-notebook>

 

 

3. coming soon...

 

 

 

 

1

1

1

readme

• [Edit it on GitHub](https://github.com/xgqfrms/blogs/blob/master/index.rst)
• [Share URL](https://readthedocs.org/projects/xgqfrms-blogs/)
• [Read it on Read the Docs](http://xgqfrms-blogs.readthedocs.io/en/latest/)

[reStructuredText(.rst)语法规则快速入门](http://blog.useasp.net/archive/2014/09/05/rst-file-restructuredtext-markup-syntax-quikstart.aspx)

./master/docs/index.rst 优先级高于 ./master/index.rst

 

 

 

https://readthedocs.org/dashboard/

 

https://github.com/xgqfrms/blogs/tree/master/docs

1

1

1

1