Aganglada Mdblog Save

✍ Markdown implementation of a blog for developers

Project README

✍ mdblog

Markdown blog implementation for developers.

  • Fast: Preact is on place, so it can't be slow ⚡.
  • Minimal: Super simple structure from preact-minimal
  • Easy to extend: Markdown based, just add one more file to posts/ and you're done 💪

Usage

Clone the project

git clone [email protected]:aganglada/mdblog.git

Enter the folder

cd mdblog

Install dependencies

yarn 

If you are using npm...

npm i

Run the dev server

npm run dev

You can start developing now on http://localhost:4000

Build assets for production

npm run prod

Running this command will create an assets folder that you can expose to your server.

Production mode in local

npm run start

You can check on http://localhost:8080

How to add post

Can it be easier?

  • Go to posts/ folder in the root structure.
  • Remove the example files.
  • Add a new one.

What's missing

  • Pagination
  • Themes
  • Your suggestions

Contributing

Pull request are more than welcome

License

MIT

Open Source Agenda is not affiliated with "Aganglada Mdblog" Project. README Source: aganglada/mdblog
Stars
29
Open Issues
1
Last Commit
7 years ago
Repository
License
MIT

Open Source Agenda Badge

Open Source Agenda Rating