Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/NayamAmarshe/writedown

✏ writedown - Free and Open Source Markdown Diary. Public Blogs and Private Notes.
https://github.com/NayamAmarshe/writedown

diary diary-app markdown notes notes-app notion notion-alternative writedown

Last synced: 7 days ago
JSON representation

✏ writedown - Free and Open Source Markdown Diary. Public Blogs and Private Notes.

Awesome Lists containing this project

README

        

# ✏ [writedown (beta)](https://writedown.app)

#### Free and Open Source Markdown Diary

#### Public Blogs and Private Notes

Write. Share. Inspire.

**writedown** is the new way of writing markdown notes fast and easily.
With a beautiful interface and polished user experience, writedown is simple but powerful.

![806shots_so (1)](https://user-images.githubusercontent.com/25067102/232125868-062e2438-c387-4c30-86e2-2766ff300cd0.png)

## 🤔 Why writedown?

Love simplicity? **Good.**
Hate complexity? **Even Better!**

**writedown**'s focus is on providing a polished experience. A simple markdown editor you can use for writing notes quickly to publish and share them with the world.

### Here's what writedown provides that most other editors don't:

📴 **Offline support**
☁️ **Cloud Sync**
🤝 **Free and Open Source**
🪟 **Real-time Markdown Preview**
📨 **Publishing and Sharing**
🌹 **Simple and beautiful interface**

[**GET STARTED IN JUST 5 SECONDS!**](https://writedown.app/login)

## ✨ Features

### Here are the markdown features that writedown supports:

- Headings (1 to 4)
- Bold
- Italics
- Underline
- Quotes
- Strikethrough
- Ordered List
- Unordered List
- Task List
- Code Block
- Image
- Horizontal Rule (Line)

### Along with that, writedown lets you:

- Share posts with people
- Create your personalized landing page
- Add your social media links

and many more being added as you read this!

## 🧑‍💻️ Development

writedown is self-hostable with Firebase and Node.js.
To run a local instance, follow these steps:

0. First install [Volta](https://volta.sh/). Then open your terminal and enter: `volta install node`.
1. Enter the following commands in your terminal.

```bash
git clone https://github.com/NayamAmarshe/writedown
cd writedown
```

2. [Setup Firebase Emulator](https://github.com/NayamAmarshe/writedown/blob/main/docs/firebase.md)
3. [Setup TipTap Editor](docs/tiptap.md)
4. Install dependencies with: `npm install`
5. Run local dev server with: `npm run dev`
OR local production server with `npm run build && npm run start`.

#

© 2023 **writedown**. All rights reserved.