Este repo foi criado com o objetivo de partilhar resumos das várias UCs do curso de LEIC-A no Instituto Superior Técnico. Qualquer contribuição é bem-vinda (exceto material de professores, como slides e livros, falem primeiro connosco).
Se estás a pensar contribuir para os Resumos LEIC, fizemos um guia passo a passo só para ti! Vai à nossa documentação para aprenderes tudo o que precisas.
Se já percebes do assunto e apenas queres instruções rápidas, segue os passos abaixo.
Para correr o código localmente, é necessário as seguintes ferramentas: git
, nodejs
e yarn
.
Abaixo encontram-se instruções para instalação em Windows e Linux.
- Fazer download do
git
e instalar o executável. - Fazer download do
node
e instalar a última versão LTS (18.X ou superior). - Instalar o
yarn
através da PowerShell, correndo o comandonpm i -g yarn
.
- Instalar o
git
e onode
pelo package manager da distribuição. Atenção que onode
em Debian/Ubuntu/etc está desatualizado. Recomendo seguir este tutorial para ter o Node 18 LTS. - Instalar o
yarn
através do terminal, correndo o comandonpm i -g yarn
.
-
Fazer fork do repositório.
-
Fazer clone do repo:
git clone [email protected]:<o-teu-username>/resumos-leic.git
-
Adicionar o remote
upstream
ao repositório:git remote add upstream https://github.com/leic-pt/resumos-leic.git
-
Instalar dependências:
cd resumos-leic yarn # or yarn install
Os ficheiros .md
(markdown) estão na pasta da respetiva UC dentro de content
.
Assim que um ficheiro .md
é adicionado à respetiva pasta da UC (e esteja associado a um type
), é acessível a partir da sidebar.
Tem ainda de ser definido o respetivo path
(/asa/introducao
, por exemplo).
Os ficheiros podem ainda ter diferentes categorias, aparecendo em diferentes sub-secções da sidebar consoante a mesma.
Em princípio, ser-vos-á útil apenas a categoria content
, que deve ser adicionada ao header de cada ficheiro.
Cada ficheiro deve conter um header com a meta-informação útil correspondente a cada ficheiro, principalmente:
-
title: <título>
, onde<título>
será o título que aparece associado à página correspondente ao ficheiro nos resumos; -
description: <bullet points>
, secção que deverá indicar sucintamente os pontos importantes abordados neste capítulo dos resumos (e que aparece no embed do URL ao partilhar o link da página); -
path: /<UC>/<nome-da-pagina>
, self-explanatory; -
type: <categoria>
, tal como mencionado acima provavelmente apenas vos interessará a categoriacontent
.
Para iniciar o servidor local, correr o comando:
yarn dev
Antes de fazer um commit, é recomendado executar o prettier
(se usarem um editor de texto - e.g. VSCode - que já executa automaticamente, não é preciso). Devem correr o comando na raiz do repo (/home/.../resumos-leic
, portanto).
yarn format