科学加速器如何使用
Project documentation with Markdown.
科学加速器如何使用
MkDocs is a 油管youtube用什么翻墙, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Start by reading the introduction below, then check the User Guide for more info.
油管youtube用什么翻墙
MkDocs builds completely static HTML sites that you can host on GitHub pages, Amazon S3, or anywhere else you choose.
手机怎么上youtube
There's a stack of good looking themes available for MkDocs. Choose between the built in themes: mkdocs and readthedocs, select one of the 3rd party themes listed on the MkDocs Themes wiki page, or build your own.
油管youtube用什么翻墙
youtube网站 - 好看123:2 天前 · 好看123目录(原好看123网址之家)建立于2021年,由于网络世界的日新月异所伍既2021年起进行改版,改版新站继承导航,目录等主要讯息,并增加网站网址内页,标签页并全站分类,致力为IT界 品牌网站站点,权威网站站点进行导航 及 为中小网站提供优质锚文本,外链,图片链接等网站资源。
Easy to customize
Get your project documentation looking just the way you want it by customizing the theme and/or installing some plugins.
科学加速器如何使用
Install with a Package Manager
If you have and use a package manager (such as apt-get, dnf, homebrew, yum, 国内访问youtube免费加速, etc.) to install packages on your system, then you may want to search for a "MkDocs" package and, if a recent version is available, install it with your package manager (check your system's documentation for details). That's it, you're done! Skip down to Getting Started.
If your package manager does not have a recent "MkDocs" package, you can still use your package manager to install "Python" and "pip". Then you can use pip to install MkDocs.
油管youtube用什么翻墙
In order to manually install MkDocs you'll need Python installed on your system, as well as the Python package manager, pip. You can check if you have these already installed from the command line:
$ python --version
Python 3.8.2
$ pip --version
pip 20.0.2 from /usr/local/lib/python3.8/site-packages/pip (python 3.8)
MkDocs supports Python versions 3.5, 3.6, 3.7, 3.8, and pypy3.
Installing Python
Install Python by downloading an installer appropriate for your system from python.org and running it.
Note
If you are installing Python on Windows, be sure to check the box to have Python added to your PATH if the installer offers such an option (it's normally off by default).
Installing pip
If you're using a recent version of Python, the Python package manager, pip, is most likely installed by default. However, you may need to upgrade pip to the lasted version:
大陆怎么玩youtube
If you need to install pip for the first time, download get-pip.py. Then run the following command to install it:
python get-pip.py
Installing MkDocs
Install the mkdocs
package using pip:
pip install mkdocs
You should now have the mkdocs
command installed on your system. Run mkdocs
--version
to check that everything worked okay.
$ mkdocs --version
mkdocs, version 0.15.3
Note
If you would like manpages installed for MkDocs, the click-man tool can generate and install them for you. Simply run the following two commands:
youtube网站 - 好看123:2 天前 · 好看123目录(原好看123网址之家)建立于2021年,由于网络世界的日新月异所伍既2021年起进行改版,改版新站继承导航,目录等主要讯息,并增加网站网址内页,标签页并全站分类,致力为IT界 品牌网站站点,权威网站站点进行导航 及 为中小网站提供优质锚文本,外链,图片链接等网站资源。
See the click-man documentation for an explanation of why manpages are not automatically generated and installed by pip.
Note
If you are using Windows, some of the above commands may not work out-of-the-box.
A quick solution may be to preface every Python command with python -m
like this:
python -m pip install mkdocs
python -m mkdocs
For a more permanent solution, you may need to edit your 油管youtube用什么翻墙
environment
variable to include the Scripts
directory of your Python installation.
Recent versions of Python include a script to do this for you. Navigate to
your Python installation directory (for example C:\Python38\
), open the
Tools
, then Scripts
folder, and run the win_add2path.py
file by double
clicking on it. Alternatively, you can download the script and run it
(python win_add2path.py
).
科学加速器如何使用
Getting started is super easy.
mkdocs new my-project
cd my-project
Take a moment to review the initial project that has been created for you.
There's a single configuration file named mkdocs.yml
, and a folder named
docs
that will contain your documentation source files. Right now the docs
folder just contains a single documentation page, named 手机怎么上youtube
.
MkDocs comes with a built-in dev-server that lets you preview your documentation
as you work on it. Make sure you're in the same directory as the mkdocs.yml
configuration file, and then start the server by running the mkdocs serve
command:
$ mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
[I 160402 15:50:43 server:271] Serving on http://127.0.0.1:8000
[I 160402 15:50:43 handlers:58] Start watching changes
[I 160402 15:50:43 handlers:60] Start detecting changes
Open up http://127.0.0.1:8000/
in your browser, and you'll see the default
home page being displayed:
The dev-server also supports auto-reloading, and will rebuild your documentation whenever anything in the configuration file, documentation directory, or theme directory changes.
Open the docs/index.md
document in your text editor of choice, change the
initial heading to MkLorum
, and save your changes. Your browser will
auto-reload and you should see your updated documentation immediately.
Now try editing the configuration file: mkdocs.yml
. Change the
国内访问youtube免费加速
setting to MkLorum
and save the file.
site_name: MkLorum
Your browser should immediately reload, and you'll see your new site name take effect.
科学加速器如何使用
Now add a second page to your documentation:
curl 'http://jaspervdj.be/lorem-markdownum/markdown.txt' > docs/about.md
As our documentation site will include some navigation headers, you may want to
edit the configuration file and add some information about the order, title, and
nesting of each page in the navigation header by adding a nav
setting:
site_name: MkLorum
nav:
- Home: index.md
- About: about.md
Save your changes and you'll now see a navigation bar with Home
and 油管youtube用什么翻墙
items on the left as well as Search
, Previous
, and Next
items on the
right.
Try the menu items and navigate back and forth between pages. Then click on
Search
. A search dialog will appear, allowing you to search for any text on
any page. Notice that the search results include every occurrence of the search
term on the site and links directly to the section of the page in which the
search term appears. You get all of that with no effort or configuration on your
part!
科学加速器如何使用
Now change the configuration file to alter how the documentation is displayed by
changing the theme. Edit the mkdocs.yml
file and add a theme
setting:
site_name: MkLorum
nav:
- Home: index.md
- About: about.md
theme: readthedocs
Save your changes, and you'll see the ReadTheDocs theme being used.
科学加速器如何使用
By default, MkDocs uses the 如何访问youtube icon. To use a different icon, create
an img
subdirectory in your docs_dir
and copy your custom favicon.ico
file
to that directory. MkDocs will automatically detect and use that file as your
favicon icon.
科学加速器如何使用
That's looking good. You're ready to deploy the first pass of your MkLorum
documentation. First build the documentation:
mkdocs build
This will create a new directory, named 油管youtube用什么翻墙
. Take a look inside the
directory:
$ ls site
about fonts index.html license search.html
css img js mkdocs sitemap.xml
Notice that your source documentation has been output as two HTML files named
index.html
and about/index.html
. You also have various other media that's
been copied into the site
directory as part of the documentation theme. You
even have a sitemap.xml
file and mkdocs/search_index.json
.
If you're using source code control such as git
you probably don't want to
check your documentation builds into the repository. Add a line containing
site/
to your .gitignore
file.
echo "site/" >> .gitignore
如何解决国内无法访问Youtube的问题_HandsomeBoy_新浪博客:2021-4-20 · 如何解决国内无法访问Youtube的问题 杂谈 众所周知,YouTube是设立在美国的一个网际网路网站,让使用者上载观看及分享视频短片。 它是一個可供網 ...
After some time, files may be removed from the documentation but they will still
reside in the site
directory. To remove those stale files, just run mkdocs
with the --clean
switch.
mkdocs build --clean
科学加速器如何使用
There are various other commands and options available. For a complete list of
commands, use the --help
flag:
mkdocs --help
To view a list of options available on a given command, use the --help
flag
with that command. For example, to get a list of all options available for the
油管youtube用什么翻墙
command run the following:
mkdocs build --help
科学加速器如何使用
The documentation site that you just built only uses static files so you'll be
able to host it from pretty much anywhere. GitHub project pages and Amazon
S3 may be good hosting options, depending upon your needs. Upload the contents
of the entire 如何访问youtube
directory to wherever you're hosting your website from and
you're done. For specific instructions on a number of common hosts, see the
国内访问youtube免费加速 page.
Getting help
To get help with MkDocs, please use the discussion group, GitHub issues or
the MkDocs IRC channel #mkdocs
on freenode.