A place where I compose. The successor for book.
View Site »
Explore the docs
·
Report Bug
·
Request Feature
Table of Contents
This is a place that I write articles and notes to remind me about stuffs that might be useful to me in future and help other who come across the site.
The technologies and tools used with this project.
- Vue
- Nuxt
- Nuxt Content
- TailwindCSS
The list of tools that is used when development.
- npm
npm install npm@latest -g
- Pnpm
npm i -g pnpm
- Git
To run this project in your local for personal use or contribution, simply perform the following.
- Clone the repo
git clone https://github.com/data-miner00/notes.git
- Install Node dependencies
pnpm i
- Copy environment file
cp .env.example .env
- Start the development server
pnpm dev
⚠️ Important: Do not update the dependencies as it will break due to incompatibilities from the latest Nuxt and Nuxt Content.
Run the generate command and static files will be generated in the .outputs/public folder that can be put under static hosting.
pnpm generateOptionally run the preview to take a peek on how the statically generated website looks like in the production.
pnpm preview- Add PWA Manifest
- DocSearch
- Add line numbers to code block
- Add missing items to mobile navbar
- Improve semantics and accessibility
- Add date display for entries
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
List of resources that are helpful and would like to give credit to.