大家好，如果您还对写作网站源码分享不太了解，没有关系，今天就由本站为大家分享写作网站源码分享的知识，包括写作网站源码分享怎么弄的问题都会给大家分析到，还望可以解决大家的问题，下面我们就开始吧！
撰写文档
如何撰写markdown源码并安排目录结构.
目录结构
文档是普通的Markdown文件,放到项目目录里.通常目录以docs命名,和mkdocs.yml配置文件一起放置于项目的顶级目录中.
最简单的项目目录结构可能是这样的:
mkdocs.yml\ndocs/\nindex.md
默认项目主页是index.Markdown源码文件的后缀可以是以下任意一种:markdown,mdown,mkdn,mkd,md.
你可以创建多个markdown文件以创建多页文档:
mkdocs.yml\ndocs/\nindex.md\nabout.md\nlicense.md
文档目录结构决定着生成的文档的URLs.如果采用如上目录结构,生成的URLs将会如下所示:
/\n/about/\n/license/
你也可以根据需要将Markdown文件放到多级目录.
docs/\nindex.md\nuser-guide/getting-started.md\nuser-guide/configuration-options.md\nlicense.md
多级目录将生成多级URLs,如下所示:
/\n/user-guide/getting-started/\n/user-guide/configuration-options/\n/license/
链接
MkDocs可以使用Markdown超链接语法来创建链接.
内部超链接
创建内部超链接只需使用Markdown超链接语法,包含目标Markdown文档的相对路径即可.
Pleaseseethe[projectlicense](license.md)forfurtherdetails.
当运行MkDocs构建工具时,超链接将指向相应的HTML页面.
你可以通过点击链接以在新编辑器窗口中打开目标Markdown文档.
如果目标文档在另一个目录中,确保超链接中正确包含了相对路径.
Pleaseseethe[projectlicense](../about/license.md)forfurtherdetails.
你可用通过锚链接以定位到目标文档的特定部分.生成的HTML将正确转换路径部分,而不会去改变锚链接部分.
Pleaseseethe[projectlicense](about.md#license)forfurtherdetails.
图片和多媒体
除了Markdown文件,你可以在文档中包含其他文件,这些文件将在你构建文档时被复制到指定位置.可以包含图片和其他多媒体.
例如,如果你的文档需要包含一个GitHubpagesCNAMEfile和一张PNG图片,你可以安排目录结构如下:
mkdocs.yml\ndocs/\nCNAME\nindex.md\nabout.md\nlicense.md\nimg/\nscreenshot.png
要包含图片到你的源码文档,只需使用Markdown语法:
Cupcakeindexerisasnazzynewprojectforindexingsmallcakes.\n\n\n\n*Above:Cupcakeindexerinprogress*
图片链接将在构建时被嵌入,如果使用了Markdown编辑器,你还可以实时预览.
Markdown扩展
MkDocs支持以下Markdown扩展.
表格
以下是一个简单的表格:
FirstHeader|SecondHeader|ThirdHeader\n————|————-|————\nContentCell|ContentCell|ContentCell\nContentCell|ContentCell|ContentCell
可以在起始和结束位置添加管道到表格:
|FirstHeader|SecondHeader|ThirdHeader|\n|————|————-|————|\n|ContentCell|ContentCell|ContentCell|\n|ContentCell|ContentCell|ContentCell|
可以在分隔符行添加冒号已指定每一列的对其方式:
FirstHeader|SecondHeader|ThirdHeader\n:———–|:———–:|———–:\nLeft|Center|Right\nLeft|Center|Right
代码块
以三个以上`（反引号）开始一行,并在结束位置以相同数目的反引号`（反引号）开始一行即可包含一个代码块:
“`\nFencedcodeblocksarelikeStardard\nMarkdownregularcodeblocks,exceptthat\ntheyenotindentedandinsteadrelyona\nstartandendfencelinestodelimitthecode\nblock.\n“`
关于本次写作网站源码分享和写作网站源码分享怎么弄的问题分享到这里就结束了，如果解决了您的问题，我们非常高兴。