Skip to content

carlos8v/blog

Repository files navigation

Blog · GitHub license Website Up

Um simples blog sobre tecnologia.

O Projeto 💡️

O objetivo principal é compartilhar conhecimento com todo mundo, o mais simples possível. O projeto usa eleventy para transformar qualquer arquivo .md na pasta src/posts em um template html customizado. Cada post ganha sua própria url hospedado no Github Pages. Os últimos posts postados aparecem na página principal do site.

Configuração 🤝️

Todos os posts precisam estar dentro da pasta src/posts e seguir o formado: seu-post.md.

Informações importantes no frontmatter do post:

---
title: "My First Article! 🚀"
author:
  name: "Carlos Souza"
---

# Hello World!
...

As informações title, author e name são essenciais para a formação do código no site.

Outras informações opcionais:

...
cover: "https://my-awesome-picture.com/crazy-pic.png"
coverPosition: "top"
author:
  name: "Carlos Souza"
  profile: "https://avatars.githubusercontent.com/u/53836455?v=4"
tags: ["Tutorial"]
---
...

Desenvolvimento 🎯️

Rodando localmente:

$ npm install
$ npm run serve

O servidor estará disponível na url http://localhost:8080. Para hospedar altere a variável domain no arquivo src/_data/eleventyComputed.js.

...
Check this [link]({{ domain }}/articles/ainda-nao-esta-no-site)
...

O {{ domain }} será traduzido para o domínio correto assim que o código for mergeado no repositório ou para http://localhost:8080 se você estiver hospedando localmente pelo script serve;

Testes 🔧️

Para rodar os testes, primeiro você precisa instalar as dependências, então rodar npm test:

$ npm install
$ npm test

Por enquanto, você precisa preencher esses requisitos:

Post.md
Post precisa ter a informação title
Post precisa ter a informação author
Post precisa ter a informação name
Post precisa ter algum conteúdo