【云原生之Docker实战】使用docker部署mkdocs项目文档工具

已于 2023-04-14 19:14:43 修改
阅读量1.2k 收藏 6
点赞数 3
分类专栏： 云原生之Kubernetes实战 Docker部署项目实战合集 文章标签： docker 云原生 mkdocs 项目文档 开源
于 2022-12-02 16:03:17 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/jks212454/article/details/128146817
版权
本文介绍了如何使用Docker部署mkdocs，一个快速、美观的静态站点生成器，适合创建项目文档。文章详细阐述了从mkdocs的特点、检查本地Docker环境、下载镜像到使用docker-cli部署应用的全过程，最后讲解了新建和编辑文档的步骤。
摘要由CSDN通过智能技术生成

【云原生之Docker实战】使用docker部署mkdocs项目文档工具

一、mkdocs介绍

1.mkdocs简介

MkDocs 是一个用于创建项目文档的快速、简单 ，完美华丽的静态站点生成器。用 Markdown 编写文档，并在几分钟内为开源或商业项目创建一个专业的静态站点——可搜索、可自定义、超过 50 种语言，适用于所有设备。

2.mkdocs特点

  • 任意托管
    构建完全的静态 HTML 站点 ,，可以将它托管到 GitHub pages, Amazon S3 等任意地方。

  • 大量主题.
    默认包含大量美观的主题.，可以从 bootstrap, readthedocs 和 12 款 bootswatch 主题中选择。

  • 即时预览
    内建的开发服务器使你在撰写文档的时候就即时预览.，它甚至能在保存更改时自动载入，只需刷新浏览器就可以查看更改。

  • 易于配置
    可以配置文档主题。

  • 交叉索引
    使用 MkDocs 链接语法创建交叉索引。

二、检查本地环境

1.检查docker版本


                

                
                
        

        

        

    

  


        

            

                

                

                了解本专栏
                
                
                  
                订阅专栏 解锁全文
                 
                
                    
                    超级会员免费看
                
            

            
            
            
        

    

      

        

            

              
                
                  江湖有缘
                
              
            

            

                关注
              
            

        

        

          
      

      

            

                专栏目录
          

                

                        订阅专栏
                









                



	

		

			

				
					
docker-mkdocs:用于MkDocs文档站点构建器工具的简单Docker容器

				
			

			

				

					04-28
				

			

		

		

			
				
MkDocs
 这是一个简单的Docker容器，用于运行文档站点构建器工具
用法
建立影像
$ docker build -t andrglo/mkdocs .
然后
查看所有可用命令
$ docker run --rm andrglo/mkdocs help
检查版本
$ docker run --rm andrglo/mkdocs version
创建一个新项目
$ docker run --rm -v ~/my/workspace:/workspace andrglo/mkdocs new my-project
用于开发的Web服务器
$ docker run -d -p 8000:8000 -v ~/my/workspace/my-project:/workspace andrglo/mkdocs
建造
$ docker run --rm -v ~/my/workspace/my-

			
		

	



                

              
                



	

		

			

				
					
docker 安装nginx

				
			

			

				

					weixin_39360124的博客
				

				

					04-01
					
					184
					
				

			

		

		

			
				
1 下载镜像
docker pull nginx latest  # latest 代表最新版

2 创建nginx容器并启动
docker run -p80:80 --name nginx \
-v /mydata/nginx/html:/usr/share/nginx/html \
-v /mydata/nginx/logs:/var/log/nginx \
-v mydata/nginx/conf:/etc/nginx \
-d nginx:latest

-v /mydata/nginx/html:

			
		

	



                


  
              

                


	

		

			

				
					
为技术项目量身定做的文档工具MkDocs

					
最新发布

				
			

			

				

					wbsu2004的博客
				

				

					08-16
					
					6079
					
				

			

		

		

			
				
MkDocs 是一个静态网站生成器，专门用于创建项目文档。

			
		

	





	

		

			

				
					
docker 部署 mkdocs (mkdocs-material)

				
			

			

				

					南山老沙
				

				

					10-26
					
					3400
					
				

			

		

		

			
				
环境：ubuntu16.04 LTS
mkdocs官网 有详细的安装步骤。
下面的方法是通过docker来部署。
获取镜像
$  docker search mkdocs
NAME                                      DESCRIPTION                                     STARS               OFFI...

			
		

	



		

			
		



	

		

			

				
					
搭建mkdocs静态页面实践

				
			

			

				

					CoberOJ_的博客
				

				

					10-29
					
					1508
					
				

			

		

		

			
				
一、背景和介绍

背景简单说下，需要一个静态页面来呈现说明某些文档，浏览器可以直接访问，接入成本要低
	这里主要介绍mkdocs，mkdocs接入成本低，语法简单
二、准备

git：用于托管文档代码，版本迭代方便
	docker：用于快速构建mkdocs环境依赖
	jenkins：用于SCM自动同步代码到静态页面
	注：
	如果不用docker也可以，可以单独配置mkdocs的依赖环境，主要依赖...

			
		

	





	

		

			

				
					
docker中安装Mkdocs

				
			

			

				

					阿昊的博客
				

				

					04-07
					
					824
					
				

			

		

		

			
				
前言
root@localhost ~]#










linux发行版本
CentOS7


uname -srm
Linux 3.10.0-693.el7.x86_64 x86_64


docker -v
Docker version 18.06.3-ce, build d7080c1


一，搜索并拉取镜像文件
大概100多M
docker search mkdocs
docker pull squidfunk/mkdocs-material

二，生成项目目录
docker run -it

			
		

	





	

		

			

				
					
docker-mkdocs:我的mkdocs

				
			

			

				

					05-10
				

			

		

		

			
				
支持中文搜索
lunr.js:

			
		

	





	

		

			

				
					
MkDocs 部署指南

				
			

			

				

					wangwenzhe的博客
				

				

					01-29
					
					1282
					
				

			

		

		

			
				
MkDocs 可以同时编译多个 markdown 文件，形成书籍一样的文件。有多种主题供你选择，很适合项目使用。MkDocs 是快速，简单和华丽的静态网站生成器，可以构建项目文档。文档源文件在 Markdown 编写，使用单个 YAML 配置文件配置。

			
		

	





	

		

			

				
					
Docker: 使用mkdocs 生成文档

				
			

			

				

					wucong60的专栏
				

				

					03-27
					
					631
					
				

			

		

		

			
				
https://blog.csdn.net/freewebsys/article/details/79218294

https://www.wafunny.com/blog/tool/mkdocs.html


			
		

	





	

		

			

				
					
mkdocs 部署教程

				
			

			

				

					qq_41245706的博客
				

				

					11-07
					
					1794
					
				

			

		

		

			
				
一、安装mkdocs
pip install mkdocs
二、创建项目
mkdocs new testdocs
三、文档预览
mkdocs serve
四、更换主题

下载主题
pip install mkdocs-material mkdocs-windmill

mkdocs.yml里添加:
theme:  name: 'material'
五、进行mkdocs.yml配置
site_name

			
		

	





	

		

			

				
					
mkdocs-material, 面向MkDocs的材料设计主题.zip

				
			

			

				

					10-10
				

			

		

		

			
				
mkdocs-material, 面向MkDocs的材料设计主题 用于MkDocs的MkDocs的材质设计主题。 快速启动使用 pip 安装最新版本的物料：pip install mkdocs-material将以下行附加到项目的mkdocs.yml:

			
		

	





	

		

			

				
					
mkdocs-material

				
			

			

				

					04-14
				

			

		

		

			
				
mkdocs-material
 该Docker容器是原始mkdocs-material的扩展，其中添加了一些插件。
原来的
外挂程式

			
		

	





	

		

			

				
					
【云原生之Docker实战】使用Docker部署Focalboard项目管理工具

				
			

			

				

					jks212454的博客
				

				

					09-26
					
					2765
					
				

			

		

		

			
				
【云原生之Docker实战】使用Docker部署Focalboard项目管理工具

			
		

	





	

		

			

				
					
【云原生之Docker实战】使用Docker部署Taskcafe项目管理工具

				
			

			

				

					jks212454的博客
				

				

					10-01
					
					1410
					
				

			

		

		

			
				
【云原生之Docker实战】使用Docker部署Taskcafe项目管理工具

			
		

	





	

		

			

				
					
【云原生之Docker实战】使用Docker部署jenkins持续集成工具

				
			

			

				

					jks212454的博客
				

				

					11-06
					
					1962
					
				

			

		

		

			
				
【云原生之Docker实战】使用Docker部署jenkins持续集成工具

			
		

	





	

		

			

				
					
【云原生之Docker实战】使用Docker部署BookStack文档管理系统

				
			

			

				

					jks212454的博客
				

				

					10-02
					
					2918
					
				

			

		

		

			
				
【云原生之Docker实战】使用Docker部署BookStack文档管理系统

			
		

	





	

		

			

				
					
mkdocs 部署到github

				
			

			

				

					m0_62342492的博客
				

				

					07-21
					
					322
					
				

			

		

		

			
				
要将mkdocs。

			
		

	





	

		

			

				
					
Mkdocs部署静态网页至GitHub pages配置说明(mkdocs.yml)

				
			

			

				

					Wcowin的博客
				

				

					10-21
					
					1858
					
				

			

		

		

			
				
建议详细学习一下上面的官方网站↑↑↑我把我目前的配置文件mkdocs.yml代码写在下面👇🏻

			
		

	





	

		

			

				
					
【云原生之docker实战】使用docker部署halo博客系统

				
			

			

				

					05-01
				

			

		

		

			
				
Docker是目前比较流行的容器化技术，其优点在于方便管理和部署应用程序。而Halo博客系统是一款基于Java开发的博客系统，其部署过程比较复杂，需要安装JDK、MySQL等依赖。本文将介绍如何使用Docker部署Halo博客系统。

1. 安装Docker

首先需要在服务器上安装Docker，可以参考官方文档进行安装。

2. 创建Docker镜像

将Halo博客系统打包成Docker镜像，可以通过Dockerfile或者docker-compose.yml文件进行创建。在这里我们以Dockerfile为例。

先创建一个空目录，将Halo博客系统的jar包和配置文件拷贝到该目录下：

```
mkdir -p /opt/halo
cp -r halo.jar /opt/halo/
cp -r application.properties /opt/halo/
```

然后创建Dockerfile：

```
FROM openjdk:8-jre-alpine
MAINTAINER yourname <youremail@domain.com>
ADD halo.jar /opt/halo/halo.jar
ADD application.properties /opt/halo/application.properties
WORKDIR /opt/halo
CMD ["java", "-jar", "halo.jar", "--spring.config.location=application.properties"]
EXPOSE 8888
```

其中FROM指定了基础镜像，ADD将jar包和配置文件拷贝到镜像中，WORKDIR指定工作目录，CMD指定应用启动命令，EXPOSE指定容器监听的端口。

使用docker build命令创建镜像：

```
docker build -t halo .
```

其中halo为镜像名称，可以根据需要自行修改。

3. 启动容器

使用docker run命令启动容器：

```
docker run -d -p 8080:8888 --name halo-demo halo
```

其中-d表示启动守护进程，-p将容器的8888端口映射到主机的8080端口，--name指定容器名称，halo为镜像名称。

启动成功后，在浏览器中输入http://localhost:8080访问Halo博客系统即可。

以上就是使用Docker部署Halo博客系统的步骤，相信通过这个实战，大家可以更好地了解云原生中Docker的使用和部署。

			
		

	



              




          




        



    





    



      

      

        
      

      





	

		评论	
	

	
	




  

    

      添加红包
      
    

    

      

        
        

          
          
        

        
请填写红包祝福语或标题

      

      

        
        

          
          个
        

        
红包个数最小为10个

      

      

        
        

          
          元
        

        
红包金额最低5元

      

      

        
        

          当前余额3.43元
          前往充值 >
        

      

      

        

          需支付：10.00元
        

        
        
      

    

  





  

    
    
  

  

    
    
  








  

    

      

        

          

            
            
成就一亿技术人!

          

          

        

        

          

          

            领取后你会自动成为博主和红包主的粉丝
            规则
          

        

      

      

        

          

            
              
            
            

              
hope_wisdom
 发出的红包
            

          

        

        

          

          

          

        

      

    

    

  





	
打赏作者

	

		

		
			
		
		

		

			
江湖有缘

			
你的鼓励将是我创作的最大动力

		

	

	

			

	

	

    ¥1
    ¥2
    ¥4
    ¥6
    ¥10
    ¥20
	

	

		

			

				

					扫码支付：¥1
				

				

					

					
					获取中
					

				

				

					
					
					扫码支付
				

			

		

		

			
您的余额不足，请更换扫码支付或充值

			
打赏作者

		

	



      
      

      
实付元

      
使用余额支付

      

        

          

            
            点击重新获取
          

        

        
扫码支付

      

      

        
          
            
          
          
        
      

      

        
        钱包余额
          0
          

            
            

              

                
抵扣说明：

                
 1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
 2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

              

            

          

      

      余额充值