MCPcopy Index your code
hub / github.com/NayamAmarshe/writedown

github.com/NayamAmarshe/writedown @main

Chat with this repo
repository ↗ · DeepWiki ↗ · + Follow
77 symbols 250 edges 58 files 0 documented · 0%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

writedown (beta)

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.

Extension points exported contracts — how you extend this code

IFirebaseAuth (Interface)
(no doc)
types/components/firebase-hooks.d.ts
ModalProps (Interface)
(no doc)
components/ui/Modal.tsx
Commands (Interface)
(no doc)
components/dashboard/TextArea/LinkPreview.tsx
Props (Interface)
(no doc)
pages/[username]/posts/[postId].tsx
ButtonProps (Interface)
(no doc)
components/ui/Button.tsx
SidebarProps (Interface)
(no doc)
components/dashboard/Sidebar/index.tsx
editorProps (Interface)
(no doc)
components/ui/WritedownEditor.tsx

Core symbols most depended-on inside this repo

useUser
called by 7
components/hooks/useUser.ts
useNotes
called by 3
components/hooks/useNotes.ts
converter
called by 3
utils/firestoreDataConverter.ts
login
called by 2
components/login/SignInArea.tsx
formatTimeStamp
called by 2
components/dashboard/TextArea/PostButtons.tsx
switchNotesHandler
called by 2
components/dashboard/Sidebar/PostRow.tsx
resetStates
called by 2
components/hooks/UsePaginateQuery.ts
getButtonClass
called by 1
components/ui/Button.tsx

Shape

Function 70
Interface 7

Languages

TypeScript100%

Modules by API surface

components/dashboard/TextArea/PostButtons.tsx7 symbols
components/dashboard/TextArea/LinkPreview.tsx7 symbols
components/hooks/useUser.ts6 symbols
pages/[username]/posts/[postId].tsx3 symbols
components/ui/Button.tsx3 symbols
components/hooks/UsePaginateQuery.ts3 symbols
components/dashboard/Sidebar/index.tsx3 symbols
components/dashboard/CheckUsername.tsx3 symbols
components/ui/WritedownEditor.tsx2 symbols
components/ui/Modal.tsx2 symbols
components/ui/Badge.tsx2 symbols
components/login/SignInArea.tsx2 symbols

For agents

$ claude mcp add writedown \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact