起初只是看到这篇CSDN推送的励志故事,突然发现Docusaurus很合我意,但在简中范围内查询了一下发现东西不少,但都只聊得比较肤浅,不能让小白很快理解,不过建议还是应该看一下Docusaurus术语相关的分享,下面是创作助手给出的信息,
Docusaurus是一个用于构建静态网站的开源工具,可以用于创建个人网站。以下是使用Docusaurus构建私人网站的步骤:
- 安装Node.js:Docusaurus是一个基于Node.js的工具,所以首先需要安装Node.js。可以访问Node.js官方网站下载安装程序,然后按照安装向导进行安装。
- 创建一个新的Docusaurus项目:打开命令行界面,进入你想要创建项目的目录,在命令行中运行以下命令:
npx @docusaurus/init@latest init my-website classic
这将使用Docusaurus模板创建一个新的Docusaurus项目。
3. 进入项目目录:运行以下命令,进入项目目录:
cd my-website
- 编辑配置文件:使用你喜欢的文本编辑器打开
docusaurus.config.js
文件,这是Docusaurus的配置文件。在文件中,你可以修改网站的标题、描述和其他设置。- 编辑页面内容:在
docs
文件夹中创建Markdown文件来编写网站的内容。每个Markdown文件对应网站中的一个页面。可以使用Markdown语法编写内容,并可以在文件头部添加一些元数据,如标题和描述。- 启动本地开发服务器:在命令行中运行以下命令,启动Docusaurus的本地开发服务器:
npm run start
这将在本地启动一个服务器,并在浏览器中打开网站。
7. 构建网站:当你对网站内容进行了修改并准备好发布时,可以运行以下命令构建静态网站:
npm run build
这将生成一个可发布的静态网站,存储在
build
文件夹中。
8. 部署网站:将生成的静态网站文件上传到一个Web服务器上,以将网站部署到互联网上。你可以使用各种各样的Web服务器来托管Docusaurus网站,如Apache、Nginx等。
这些是使用Docusaurus构建私人网站的基本步骤。你可以根据自己的需求和喜好进一步定制和扩展你的网站。Docusaurus文档提供了更详细的指南和教程,你可以访问Docusaurus官方网站获得更多信息。
需要提醒的是,这里涉及到两部分,第一是Docusaurus本身,它可以把md文件生成为静态网站文件,当然包括网站需要的所有构架的相关文件;第二个是网站,可以是Apache、Nginx或其他的Web Server。
虽然Docusaurus有一定的网站功能,但对环境还是有一定要求的,用单片机没有成功,而且Docusaurus对Markdown格式还是有要求的,不接受HTML控制符,但同时有很多漂亮的扩展,这些扩展又是一般Markdown 编辑器不认识的,在也是需要探索和平衡的地方。比如下面的控制符例子:
:::note
Some content with Markdown syntax
. Check this api
.
:::
:::tip
Some content with Markdown syntax
. Check this api
.
:::
:::info
Some content with Markdown syntax
. Check this api
.
:::
:::warning
Some content with Markdown syntax
. Check this api
.
:::
:::danger
Some content with Markdown syntax
. Check this api
.
:::
👆在IT书中经常会看到的符号,现在可以很方便地用在Docusaurus文件中。
安装Node.js所需的空间取决于所下载的安装包的版本和平台。一般来说,Windows平台的安装包大小约为30-50MB,Mac平台的安装包大小约为10-20MB,Linux平台的安装包大小约为10-20MB。但是,请注意,这只是安装包的大小,实际安装后会占用更多的空间,因为安装过程中会解压和复制一些必要的文件和库。因此,建议在安装Node.js之前保留足够的磁盘空间,以便能够容纳安装和运行Node.js所需的文件和依赖项。
安装和运行Node.js还是比较出问题,需要关注。
docusaurus的官方中文说明
在此分享一个台湾人做的非常好理解的视频,
链接: https://pan.baidu.com/s/1AV7816WQR-wlIte-dBaCNg 提取码: 0l3g 110MB
目前还没有搞得太清楚的是从docusaurus发布到自己指定网站的流程,最好是用docusaurus的工具,自己手动还是容易出错。
有兴趣的网友请留言,希望可以一起挖掘探讨docusaurus。