MCPcopy Index your code
hub / github.com/GarliqBread/Noteup

github.com/GarliqBread/Noteup @0.5.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release 0.5.0 ↗ · + Follow
144 symbols 367 edges 106 files 0 documented · 0% updated 2y agoapp-v0.4.5 · 2023-09-28★ 381 open issues
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Netlify Status

Noteup [Live version](https://noteup.dev/)

A web and desktop markup notes app.

Screenshot

Noteup is a free, open-source markup notes app for the web, mobile(PWA) and desktop. Your notes are saved in the local storage, but are available for import/export.

Get started

To get started just visit noteup.dev or download a build or clone the repo and run the install and start scripts

yarn install
yarn start

To run the desktop version, after installing run

yarn tauri dev

To make a desktop build run

yarn build
yarn tauri build

Roadmap

  • [x] Tandem scroll for side-by-side editing
  • [ ] Add a page with markdown help commands
  • [ ] Note sharing
  • [ ] Account sync
  • [ ] Cross-platform sync
  • [ ] Extra download options (like .pdf)
  • [ ] Quick command bar (WYSIWYG style)

Contributing

This is an open source project, and contributions are welcomed and appreciated. Open issues, bugs, and enhancements are all listed on the issues tab and labeled accordingly.

View CONTRIBUTING.md to learn about the style guide, folder structure, scripts, and how to contribute.

Inspirations

This project was visually inspired by another markdown note app called Takenote and the macOS notes app.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Cláudio Silva 💻 📖 🚧

Author

License

This project is open source and available under the MIT License.

Extension points exported contracts — how you extend this code

Props (Interface)
(no doc)
src/components/ThemeWrapper.tsx
DefaultTheme (Interface)
(no doc)
src/styles/theme/styled.d.ts
NoteLinkProps (Interface)
(no doc)
src/components/NotePreviewer/NoteLink.tsx

Core symbols most depended-on inside this repo

wrapWithTheme
called by 10
src/components/ThemeWrapper.tsx
useWindowDimensions
called by 7
src/utils/hooks/useWindowDimensions.ts
useKey
called by 6
src/utils/hooks/useKey.ts
getNoteTitle
called by 5
src/utils/helpers.ts
handleFolderChange
called by 3
src/components/Sidebar/index.tsx
copyToClipboard
called by 2
src/utils/helpers.ts
getNotesSorter
called by 2
src/utils/sorting.ts
useDeviceOS
called by 2
src/utils/hooks/useDeviceOS.ts

Shape

Function 130
Enum 8
Interface 3
Class 2
Method 1

Languages

TypeScript99%
Rust1%

Modules by API surface

src/components/Icons.tsx27 symbols
src/views/SettingsModal/panels/Preferences.tsx8 symbols
src/utils/enums.ts8 symbols
src/components/NoteList/NoteContext.tsx7 symbols
src/components/NoteEditor/EditorBar/index.tsx7 symbols
src/components/KeyboardShortcuts.ts6 symbols
src/components/Button/index.tsx6 symbols
src/utils/helpers.ts5 symbols
src/views/NotePreviewer/index.tsx4 symbols
src/views/NoteEditor.tsx4 symbols
src/utils/editorKeymaps.ts4 symbols
src/utils/hooks/useWindowDimensions.ts3 symbols

For agents

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

⬇ download graph artifact

Ask about this repo answers extend the page