/writedown

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

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

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)

🤔 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!

✨ 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:

  1. First install Volta. Then open your terminal and enter: volta install node.
  2. Enter the following commands in your terminal.
git clone https://github.com/NayamAmarshe/writedown
cd writedown
  1. Setup Firebase Emulator
  2. Setup TipTap Editor
  3. Install dependencies with: npm install
  4. Run local dev server with: npm run dev OR local production server with npm run build && npm run start.

© 2023 writedown. All rights reserved.