Skip to content

data-miner00/notes

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Article & Notes

A place where I compose. The successor for book.
View Demo »

Explore the docs · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Acknowledgments

About The Project

Project screenshot

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.

(back to top)

Built With

The technologies and tools used with this project.

  • Vue
  • Nuxt
  • Nuxt Content
  • TailwindCSS

(back to top)

Getting Started

Prerequisites

The list of tools that is used when development.

  • npm
    npm install npm@latest -g
  • Pnpm
    npm i -g pnpm
  • Git

Installation

To run this project in your local for personal use or contribution, simply perform the following.

  1. Clone the repo
    git clone https://github.com/data-miner00/notes.git
  2. Install Node dependencies
    pnpm i
  3. 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.

Building for Production

Run the generate command and static files will be generated in the .outputs/public folder that can be put under static hosting.

pnpm generate

Optionally run the preview to take a peek on how the statically generated website looks like in the production.

pnpm preview

(back to top)

Roadmap

  • 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).

(back to top)

Contributing

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!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Acknowledgments

List of resources that are helpful and would like to give credit to.

(back to top)