制作帮助文档站点
推荐使用静态站点生成器制作帮助文档站点,本站即为一个实际案例。
您需要准备的基础条件
在全部委托的打包服务中,我们会协助制作好静态站点并做些基础设置,大体效果如本站。
为此,您需要准备一些基础条件:
· 您需要有自己的服务器或者云服务器,以便安装站点。
· 如需要通过域名访问该站点,则您需要准备一个已备案的域名。
如果需要自行编辑文档
如需要自行编辑文档网站,请按照以下步骤操作:
· 在您的设备上安装好node.js(建议勾选全部依赖项)和vscode(按提示安装必要的扩展)
· 按照静态站点生成器的说明文档在本地计算机上创建站点。
· 在站点文件夹中,使用CMD运行以下命令启动站点:
npm start
· 如果已正常安装,则您会在localhost:3000中预览到该站点,并可在vscode中编辑相关页面。
· 编辑完毕后,在CMD中使用以下命令生成静态站点文件:
npm run build
· 静态文件生成后,即可上传到您的服务器或者云端,通过IP:端口或者域名进行访问。
以上过程中,会涉及到很多技术细节。如果您觉得比较复杂,也可将该部分服务打包委托。
常用的markdown语法
文字加粗
可以用(*)或(_)将文字包围起来,代码如下(注意"**"与文字之间没有空格):
**需要加粗的文字**
效果为:需要加粗的文字
文字倾斜
可以用*或(_)将文字包围起来,代码如下(注意之间没有空格):
*需要倾斜的文字*
效果为:需要倾斜的文字
插入链接
可以用[]和()的组合来实现,[]中填入您需要加链接的文字,()中填入您需要加的链接。代码如下:
[模链丨周周向上.AI](https://zhouzhouxiangshang.com)
效果为:模链丨周周向上.AI;此语法也适用于文件下载。
插入邮件
使用插入链接类似的语法,代码如下:
[给我发邮件至:18049700567@163.com](mailto:18049700567@163.com)
效果如下:给我发邮件至:18049700567@163.com
插入图片
可以使用!、[]和()的组合来实现,其中[]中填入图片无法显示时的替代文字,()填入图片地址。代码如下:
![这是一张图片](https://zhouzhouxiangshang.com/img/logo.svg)
由于图片较大,为免影响使用,此处不展示效果。
博文折叠
如果博客文章比较长又不想在博客首页全文展示,可以在博文适当的地方插入以下字符:
<!--truncate-->
其他可选建议
为了方便,您可以选择将CMD命令集成到鼠标右键中,以便随时使用。但该操作需要修改注册表,如风险不可承受,则不必要进行操作。