reStructuredText(.rst) && read the docs

 

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

 

 

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

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

 

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