raulfdm / annotation-book

Personal online Notebook :notebook:

Deprecation Warning

With the advance of new technologies like Notion, this project isn't needed anymore. Actually I migrate my Notebook to there and you can find the link of it here.

---

Personal Notebook Annotation

Personal online notebook to write down my studies, ideas, bug solutions and what else I want to 📓

• Github Project
• Online Notebook

---

!> Most of my notes were wrote in pt-BR (🇧🇷) because it's my mother language. So if you're not a portuguese speaker the annotations won't make sense at all, however, I'm writing this introduction in english to make it possible everyone uses the base structure and create your own notebook :).

How to Use

The first version of this project was based on Gitbook. However, after read this issue on Gitbook's repository it seems the team will not keep Gitbook V2 open-source. Also there's no reply and answers on the issues there so I've just decided to find another open-source and well maintained solution which solves my problem.

About Docsify

Docsify is a really nice tool to build web documentation writing markdown. They use VueJS, which makes the lib way lighter and also fast.

I really like this tool because:

• it's been maintained by the community;
• run fast on dev mode and don't have to build;
• Easy configurable and customizable;
• Documentation clear and neat with some really good examples and showcases;

Running

1. Clone this project;
2. Install the dependencies:

yarn install
# or
npm install

1. Run it locally:

yarn dev
# or
npm dev

Folder Structure

Here's the folder structure of this project:

annotation-book/
├── docs/
│   ├── development/*
│   └── ...
├── _sidebar.md
├── index.html
└── package.json

However, it's also possible to customize as you want, like add all those files inside a docs folder. See more about it here.

_sidebar.md

Here's the main sidebar structure. If you navigate through folders inside docs, you'll more _sidebar.md files. Fortunately Docsify allow us to have nested Sidebars as you can see on their documentation.

index.html

Here's the entry point of the project. It's the place where we init Docisfy and also import themes, plugins and customize things.

Also the this is the file to be hosted (together with the docs of course) by the http server (e.g. Netlify, Github Pages, Gitlab Pages, etc.).