https://github.com/aganglada/mdblog
✍ Markdown implementation of a blog for developers
https://github.com/aganglada/mdblog
blog markdown preact preact-apps
Last synced: 5 days ago
JSON representation
✍ Markdown implementation of a blog for developers
- Host: GitHub
- URL: https://github.com/aganglada/mdblog
- Owner: aganglada
- License: mit
- Created: 2017-03-05T10:32:10.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-10T12:31:09.000Z (over 8 years ago)
- Last Synced: 2025-04-12T11:49:46.387Z (2 months ago)
- Topics: blog, markdown, preact, preact-apps
- Language: JavaScript
- Size: 201 KB
- Stars: 29
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this 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](https://github.com/aganglada/preact-minimal)
* **Easy to extend**: Markdown based, just add one more file to `posts/` and you're done 💪
### Usage
Clone the project
```bash
git clone [email protected]:aganglada/mdblog.git
```
Enter the folder
```bash
cd mdblog
```
Install dependencies
```bash
yarn
```
If you are using npm...
```bash
npm i
```
#### Run the dev server
```bash
npm run dev
```
You can start developing now on http://localhost:4000
#### Build assets for production
```bash
npm run prod
```
Running this command will create an `assets` folder that you can expose to your server.
#### Production mode in local
```bash
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](https://github.com/aganglada/mdblog/pulls) are more than welcome
### License
MIT