Getting started
Install Node, run it locally and create your first page.
Requirements
- Node.js 20.9 or newer
- pnpm (the repository ships a pnpm lockfile; npm also works)
- A modern browser
Install and run
git clone https://github.com/0x0f2Root/Node.git
cd Node
pnpm install
pnpm devOpen http://localhost:3000 in your browser.
For a production build, use pnpm build followed by pnpm start.
Keep Node on your own machine
Node has no accounts or login. Anyone who can reach the server can read and change your pages, so do not expose it to a network you do not trust.
Create your first workspace
A page always lives inside a workspace, so Node asks for one first.
- Click New page on the home screen, or the pencil icon at the top of the sidebar.
- With no workspace yet, the New workspace dialog opens. Give it a name, and optionally a description and an icon.
- Create a page inside it. The page opens with its title selected, so you can type a name straight away.
- Press Enter to move from the title into the document and start writing.
Node creates the data/pages/ directory the first time it needs it. After these steps it looks like this:
data/pages/
└── Pentesting/ ← the workspace
└── Untitled.md ← the page (renamed when you change its title)Find your way around
| Place | What it shows |
|---|---|
| Home | A greeting, your recently opened pages and your favorites. |
| All pages | Every page, most recently updated first. |
| Calendar | Events and task due dates. |
| Tasks | The Kanban board. |
| Sidebar | Favorites, Recent, the Workspaces tree and imported Repositories. |
| Settings | Appearance, editor options, storage and keyboard shortcuts. |
Press Ctrl K (⌘ K on macOS) anywhere to open the command palette, which can jump to any page or run any command.
Already have Markdown notes?
You have two options:
- Use Import Markdown on the home screen to pick files. See Import and export.
- Copy your folders straight into
data/pages/, then choose Reload from disk. Top-level folders become workspaces.