Descarga jekyll doc theme - Descarga del código fuente jekyll doc theme

jekyll doc theme

Otras categorias

1.0.0

Descargar

Tema Jekyll Doc

Vaya al sitio web para obtener información detallada y una demostración.

Ejecutando localmente

Necesitas Ruby y gema antes de comenzar, luego:

 # install bundler
gem install bundler

# clone the project
git clone https://github.com/aksakalli/jekyll-doc-theme.git
cd jekyll-doc-theme

# install dependencies
bundle install

# run jekyll with dependencies
bundle exec jekyll serve

Recursos temáticos

A partir de la transición para admitir páginas de Github, varios archivos se han reubicado en la carpeta /asset .

css/
fuentes/
imagen/
js/
404.html
todas las publicaciones.html
búsqueda.json

Estibador

Alternativamente, puede implementarlo utilizando el Dockerfile de varias etapas que sirve archivos de Nginx para un mejor rendimiento en producción.

Cree la imagen para JEKYLL_BASEURL de su sitio:

 docker build --build-arg JEKYLL_BASEURL="/your-base/url" -t jekyll-doc-theme .

(o déjelo vacío para root: JEKYLL_BASEURL="" ) y sírvalo:

 docker run -p 8080:80 jekyll-doc-theme

Páginas de Github

El tema también está disponible para Github Pages mediante el uso del complemento Tema remoto:

Archivo de gemas

 # If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
gem "github-pages", group: :jekyll_plugins

_config.yml

 # Configure the remote_theme plugin with the gh-pages branch
# or the specific tag
remote_theme: aksakalli/jekyll-doc-theme@gh-pages

Recursos temáticos

Los archivos de su proyecto anularán cualquier archivo de tema con el mismo nombre. Por ejemplo, el caso de uso más comentado para esto sería modificar el tema o los colores de su sitio. Para ello se deben seguir los siguientes pasos:

Copie el contenido de aksakalli/jekyll-doc-theme/asset/css/main.scss a su propio proyecto (manteniendo la estructura de carpetas)
Modifique las variables que desea utilizar antes de las declaraciones de importación, por ejemplo:

 // Bootstrap variable overrides
$grid-gutter-width: 30px !default;
$container-desktop: (900px + $grid-gutter-width) !default;
$container-large-desktop: (900px + $grid-gutter-width) !default;

@import // Original import statement
  {% if site.bootwatch %}
    "bootswatch/{{site.bootwatch | downcase}}/variables",
  {% endif %}

  "bootstrap",

  {% if site.bootwatch %}
    "bootswatch/{{site.bootwatch | downcase}}/bootswatch",
  {% endif %}

  "syntax-highlighting",
  "typeahead",
  "jekyll-doc-theme"
;

// More custom overrides.