Tutorial para iniciarse en la programación con lenguaje C elaborado con mkdocs.
El resultado de este proyecto está publicado en esta página.
mkdocs es una herramienta para crear documentación.
Entre sus ventajas destacan las siguientes:
- Permite escribir en lenguaje markdown.
- Es posible utilizar extensiones, por ejemplo, para resaltar en colores código.
- Incluye un servidor web que permite visualizar los cambios según vamos escribiendo.
- Permite crear facilmente un sitio web estático con la documentación generada.
Comprobaremos si tenemos instalado Python y PIP con los siguientes comandos:
python --version
pip --version
En caso de no tenerlos instalados, podemos hacerlo instalando Anaconda. En caso de tenerlos instalados, actualizaremos pip a la última versión con el siguiente comando:
pip install --upgrade pip
A continuación ya podemos instalar mkdocs con el siguiente comando:
pip install mkdocs
Tras la instalación podemos comprobar la versión instalada con:
mkdocs --version
En caso de utilizar el tema material para mkdocs lo instalaremos de la siguiente forma:
pip install mkdocs-material
Para utilizar la extensión CodeHilite es necesario instalar pygments:
pip install pygments
Para utilizar la extensión PyMdown que entre otros paquetes incluye arithmatex (MathJax) es necesario instalarla:
pip install pymdown-extensions
mkdocs new [dir-name]
- Create a new project.mkdocs serve
- Start the live-reloading docs server.mkdocs build
- Build the documentation site.mkdocs help
- Print this help message.
-
Abrir una consola DOS.
-
Teclear (incluyendo la ruta a la carpeta de trabajo):
cd Documents/mkdocs/curso-c mkdocs serve
-
Abrir el navegador en http://127.0.0.1:8000/
-
Comenzar la edición de los documentos.