Skip to content
This repository has been archived by the owner on Jun 3, 2024. It is now read-only.

Latest commit

 

History

History
186 lines (140 loc) · 5.91 KB

README.md

File metadata and controls

186 lines (140 loc) · 5.91 KB
Raw

Contributors Forks Stargazers Issues MIT License


Book

A simple book that I use for documenting technical things that matter.
View Demo »

Explore 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

A simplistic and boring site that I used to document all things technical that I find interesting and worth a note.

The decision to develop a place to keep my notes is rather coincidental, whereby I am studying some online articles and books about Rust and came across this note by Ivan Veselov and his teams on Gitbook, which immediately caught my attention and sparked the idea of developing an online "book" website that serves as the knowledge repository about some quick but important topics for me and others that might find it useful.

⚠ Deprecation notice: This project is obsolete. Part of it had been migrated to my notes project.

(back to top)

Built With

The technologies and tools used within this template.

  • Nuxt 2
  • TypeScript
  • TailwindCSS

(back to top)

Getting Started

Prerequisites

The list of tools that is used when development.

  • npm 
    npm install npm@latest -g
  • yarn 
    npm install yarn -g
  • Git

Installation

Installation is fairly straightforward. Just clone the repo and run yarn && yarn dev.

  1. Clone the repo 
    git clone https://github.com/data-miner00/book.git
  2. Install Node dependencies 
    yarn
  3. Start local dev server 
    yarn dev
  4. Generate static HTML for production 
    yarn generate

(back to top)

Roadmap

  • Add dynamic table of content
  • Add menu footer
  • Update article footer
  • Add search function
  • Add image component
  • Extract Main page and Article page into different component that can be customized
  • Add mobile responsiveness
  • Add tags
  • Add search icon tooltip
  • Add Mobile header bar with burger menu
  • Add accessibility and use semantic tags

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)