首页 > 其他分享> 文章详细

快速搭建一个文档站点

2021-12-19 11:35:30 阅读：207 来源： 互联网

标签：bytesfly compose island sudo 站点 nginx 文档 conf 搭建

开发人员最熟悉的Git+Markdown工具即可轻松维护一个简约大气的文档站点，效果如下：

访问地址：https://bytesfly.github.io/island

使用GitHub Pages部署

参考： https://docsify.js.org/#/zh-cn/deploy

使用GitHub Pages部署一个文档站点非常简单，这里假定你已经有了GitHub账号，没有的话，注册一下。

第一步：Fork我当前island仓库，即 https://github.com/bytesfly/island

第二步：在刚Fork的仓库设置(Settings)页面开启GitHub Pages功能

然后，你就可以打开https://<yourname>.github.io/island看看效果了。

本地部署

如何在本地编辑文档并实时预览效果呢？

第一步：克隆文档项目

仓库所在地址： https://github.com/bytesfly/island

git clone git@github.com:bytesfly/island.git

第二步：安装启动nginx

Linux系统：

# 安装
sudo apt-get install nginx

# 查看状态
sudo systemctl status nginx

# 启动
sudo systemctl start nginx

Windows系统(待补充)：

# TODO

如果安装启动成功，浏览器打开 http://localhost/ ，可见如下界面：

第三步：配置nginx

Linux系统：

# 进入nginx配置目录
cd /etc/nginx/conf.d

# 创建新配置
sudo touch island.conf

然后打开island.conf，添加如下内容：

server {
  listen 12345;
  root /home/bytesfly/proj/island;
  index index.html;
  location ~* ^.+\.(jpg|jpeg|gif|png|ico|css|js|pdf|txt){
    root /home/bytesfly/proj/island;
  }
}

其中root后面配置的是刚才克隆的island项目绝对路径。

再执行命令让nginx重新加载：

sudo nginx -s reload

浏览器打开 http://localhost:12345/ ,如下

此时，用你喜欢的本地编辑器编写Markdown文档并保存，浏览器刷新页面(Ctrl + F5)即可实时预览效果。

补充Docker部署

当然，如果本地有Docker环境，也可使用Docker部署。下面以docker-compose为例。

下面是整体目录结构，当前目录下有docker-compose.yml文件和conf.d文件夹，conf.d文件夹下有island.conf文件。

➜  ~ tree
.
├── conf.d
│   └── island.conf
└── docker-compose.yml

1 directory, 2 files

docker-compose.yml文件内容如下：

version: '3.9'
services:
  nginx:
    image: nginx:1.20.1
    volumes:
      - ./conf.d:/etc/nginx/conf.d:ro
      - /home/bytesfly/proj/island:/var/www
    ports:
      - "8080:8080"
    networks:
      internal:  {}
    restart: always
networks:
  internal: {}

其中/home/bytesfly/proj/island是文档项目所在绝对路径。

island.conf文件内容如下：

server {
  listen 8080;
  root /var/www;
  index index.html;
  location ~* ^.+\.(jpg|jpeg|gif|png|ico|css|js|pdf|txt){
    root /var/www;
  }
}

在docker-compose.yml当前目录执行如下命令：

sudo docker-compose up -d

如果没有其他问题的话，浏览器打开 http://localhost:8080/ 查看文档。

标签：bytesfly,compose,island,sudo,站点,nginx,文档,conf,搭建
来源： https://www.cnblogs.com/bytesfly/p/deploy-a-document-site.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9

快速搭建一个文档站点

使用GitHub Pages部署

本地部署

补充Docker部署