Usuario:ManuelRomero/vuepress

De WikiEducator
Saltar a: navegación, buscar

Referencias Web




Vuepress

  • Es un entorno para crear sitios estáticos usando vue e integrado con markdown




Icon activity.jpg
Instalación gobal
sudo npm  install -g  vuepress





Icon activity.jpg
Crear un proyecto
  • Creamos un directorio y nos ubicamos en él
mkdir probando_vuepress
cd  probando_vuepress






Icon activity.jpg
Inicializamos el proyecto
  • Con ello se crea el fichero pakage.json
npm init -y





Icon activity.jpg
Editamos pakage.json
  • Abrimos el fichero
  • Modificamos la entrada script sustituyéndola por el siguiente contendio
{
  "scripts": {
    "docs:dev": "vuepress dev docs",
    "docs:build": "vuepress build docs"
  }
}





Icon activity.jpg
Estructura de directorios
  • Vuepress propone una estructura de directorios que es recomendable (no obligatorio) seguir
  • Explicada con detalle en la web de referencia
https://vuepress.vuejs.org/guide/directory-structure.html

Structure dir vuepress project.png

  • Cremos el directorio básico docs y en su contenido .vuepress,
mkdir docs
cd docs
mkdir .vuepress
cd .vuepress
  • Creamos también el fichero config.js. Este fichero va a contener la configuración de nuestro proyecto
  • Creamos un fichero llamdo README.md. Este fichero va a ser el index de nuestro contenido
touch config.js (o bien desde el EDI)
touch README.md (o bien desde el EDI)





Icon activity.jpg
Configurando el proyecto: config.js
  • A continuación modificamos el fichero config.js
  • En este fichero debemos establecer las variables de configuración para nuestro proyecto
  • Las directivas de configuración están descrigas en la web oficial
https://vuepress.vuejs.org/config/#basic-config
module.exports = {
    base : '/'
    title: 'Probando Vuepress',
    description: 'Cómo sacar mayor partido a Vuepress y para qué sirve!',
    head: [
        ['link', {
            rel: 'icon',
            href: `/favicon.ico`
        }]
    ],
    dest: './docs/.vuepress/dist',
    ga: '',
    evergreen: true,
}




{{


Icon activity.jpg
Contendio del proyecto
  • Vamos a escribir algo en nuestro fichero README.md
  • Lógicamente escribimos con sintaxis de markdown

Idioma no válido.

Necesita especificar un idioma como esto: <source lang="html4strict">...</source>

lenguajes soportados para sintaxis remarcada:

4cs, 6502acme, 6502kickass, 6502tasm, 68000devpac, abap, actionscript, actionscript3, ada, algol68, apache, applescript, apt_sources, arm, asm, asp, asymptote, autoconf, autohotkey, autoit, avisynth, awk, bascomavr, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_loadrunner, c_mac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, coffeescript, cpp, cpp-qt, csharp, css, cuesheet, d, dcl, dcpu16, dcs, delphi, diff, div, dos, dot, e, ecmascript, eiffel, email, epc, erlang, euphoria, f1, falcon, fo, fortran, freebasic, freeswitch, fsharp, gambas, gdb, genero, genie, gettext, glsl, gml, gnuplot, go, groovy, gwbasic, haskell, haxe, hicest, hq9plus, html4strict, html5, icon, idl, ini, inno, intercal, io, j, java, java5, javascript, jquery, kixtart, klonec, klonecpp, latex, lb, ldif, lisp, llvm, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, mmix, modula2, modula3, mpasm, mxml, mysql, nagios, netrexx, newlisp, nsis, oberon2, objc, objeck, ocaml, ocaml-brief, octave, oobas, oorexx, oracle11, oracle8, oxygene, oz, parasail, parigp, pascal, pcre, per, perl, perl6, pf, php, php-brief, pic16, pike, pixelbender, pli, plsql, postgresql, povray, powerbuilder, powershell, proftpd, progress, prolog, properties, providex, purebasic, pycon, pys60, python, q, qbasic, rails, rebol, reg, rexx, robots, rpmspec, rsplus, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, spark, sparql, sql, stonescript, systemverilog, tcl, teraterm, text, thinbasic, tsql, typoscript, unicon, upc, urbi, uscript, vala, vb, vbnet, vedit, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, whois, winbatch, xbasic, xml, xorg_conf, xpp, yaml, z80, zxbasic


}