Getting Started

Created 23 March 2017 by Natan Felles

Contribute on GitHub View Project | View File | Edit File

Docs Structure

Diferente de outros temas, o Jekyll Theme Docs foi desenvolvido para trabalhar com uma estrutura de arquivos pré-definida onde a estrutura de posts e categorias é organizada por diretórios.

| docs/
    | index.md
    | _posts/
        | 2017-03-24-general-post.md
    | google/
        | index.md
        | _posts/
            | 2017-03-24-create-account.md
        | gmail/
            | index.md
            | _posts/
                | 2017-03-24-how-to-send-emails.md
        | drive/
            | index.md
            | _posts/
                | 2017-03-24-uploading-to-cloud.md
    | linux/
        | index.md
        | _posts/
            | 2017-03-24-what-is.md
        | distros/
            | index.md
            | _posts/
                | 2017-03-24-debian.md
                | 2017-03-24-centos.md

Docs Categoria Pai

O principal diretório deste tema é o /docs/ que corresponderá a url /docs/ no seu website. Por isso é importante que você configure o arquivo /docs/index.md conforme suas necessidades. Basicamente você só precisa trocar o valor da variável title.

Qualquer post que você queira que seja relativo a url /docs/ deve ser adicionado dentro de /docs/_posts/.

Por exemplo: O arquivo /docs/_posts/2017-03-23-getting-started.md corresponderá a url /docs/getting-started.

Categorias

Todo diretório, exceto _posts, dentro de /docs/ será considerado uma categoria principal e dentro dele você deve adicionar um arquivo chamado index.md.

Supondo que seu site tenha uma categoria principal chamada Google você poderia adicionar o seguinte arquivo: /docs/google/index.md e então essa categoria será acessível pela url /docs/google/.

Todos os posts relativos a categoria Google devem ser adicionados dentro de /docs/google/_posts/.

Digamos que haja um post explicando como criar uma conta, então você poderia adicioná-lo nessa forma: /docs/google/_posts/2017-03-23-create-account.md. A url relativa será /docs/google/create-account.

Sub-Categorias

Seguindo a lógica aplicada em Categorias, digamos que a categoria Google possuo uma sub-categoria chamada Gmail. Então essa deve ser adicionada desta forma: /docs/google/gmail/index.md. Sendo que você deverá criar os posts dessa subcategoria em /docs/google/gmail/_posts/.


comments powered by Disqus