PROGRAMACIÓN: Docute

Paso #01

  • Descomprima el proyecto
  • Copie la carpeta en su servidor web

Paso #02: cree las carpetas css y js

mkdir css
mkdir js

Paso #03: descargue los archivos y unminify

Paso #04: index.html

  • Cree un archivo «index.html» con la siguiente información
<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
    <title>My Docs</title>
    <link rel="stylesheet" href="css/docute.css">
  </head>
  <body>
    <div id="docute"></div>
    <script src="js/docute.js"></script>
    <script>
      new Docute({
        target: '#docute'
      })
    </script>
  </body>
</html>

Paso #05: cree un README.md

  • Ahora cree un archivo README.md al mismo nivel que el index.html
  • Ejemplo:
# BIENVENIDO AYUDA SAE: DESARROLLADOR


## INTRODUCCIÓN


En este sitio web, usted va encontrar información importante para del desarrollo de módulos dentro del sistema SAE.

## ¿Qué es SAE?

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Paos#06: directorio documentación

  • Cree una estructura de directorio para distribuir la documentación
mkdir documentos
mkdir documentos/docute
mkdir documentos/seccion01
mkdir documentos/seccion02
mkdir documentos/....

Paso #07: cree un sidebar

  • Con el siguiente ejemplo:
 sidebar: [
          {
            title: 'Uso de docute',
            children: [
              {
                title: 'docute',
                link: 'documentos/docute'
              },
              {
                title: 'seccion01',
                link: 'documentos/seccion01'
              },
              {
                title: 'seccion02',
                link: 'documentos/seccion01'
              }
            ]
          },
          // An external link
          {
            title: 'GitHub',
            link: 'https://git.siua.ac.cr/siua/sae2019'
          }
        ],