/Bon5R

🔥 Bon5R — Create static, blog-aware websites with pure MDX.

Primary LanguageJavaScriptMIT LicenseMIT



Bon5R

Create static, blog-aware websites with pure MDX.
Explore the docs »

View Demo · Report Bug · Request Feature

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

About The Project

There are so many awesome frameworks to create websites out there but all of them require you to spend a substantial amount of time creating the website. I created Bon5R with the intention of allowing users to make their own websites using markdown which speeds up your workflow.

Here's why:

  • Your time should be focused on creating something amazing. A project that solves a problem and helps others.
  • You shouldn't be doing the same tasks over and over like creating a project website from scratch.
  • You should implement DRY principles to the rest of your life.

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue.

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you can set up your project locally. To get a local copy up and running follow these simple steps.

Prerequisites

Before we can create the project we will require the following dependencies installed. Begin by installing npm and then installing yarn.

Install npm

npm install npm@latest -g

Install yarn

npm install --global yarn

Installation

  1. Clone the repo. 
    yarn create bon5r-app my-app
  2. Navigate inside the directory. 
    cd my-app
  3. Star the server.
yarn dev

And thats it! you can view the server by going to http://localhost:3000.

(back to top)

Usage

As of right now, here is the current preview of the Bon5R template website.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Release Bon5R v2.0.0
  • Update documentation for Bon5R v2.0.0
    • Deployment documentation
    • Contributing documentation
  • Add Additional Templates for Bon5R

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 the LICENSE file for more information.

(back to top)

Contact

Your Name - @manusanish - manusanish@gmail.com

Project Link: https://github.com/manuanish/bon5r

(back to top)