This project uses pnpm with workspaces. Install pnpm through corepack (included with NodeJS v16.13+) with the following command:
corepack enable pnpm
Then install all dependencies with.
pnpm install
And start the development server with
cd capra-fagradar
pnpm dev
Content is found in two folders;
src/technical-radarsrc/tech-leader-radar
The files themselves are .mdx files, using .yaml frontmatter for configuration. These are the config values:
id: unusedname: what it says on the tindepth: 1-4. Seesrc/om-fagradar.mdxfor info on the depth levelsqudrant: which named quadrant to put this item in. Quadrant names are set inindex.tsxfor both radars (const quadrants = [...])
Editing can be done in two ways:
- Using an IDE
- Using Obsidian
If you have not heard of Obsidian before, you can read about them here
Requirements: IDE installed, git configured
- Clone the repo
- Open it with your IDE
- Do the changes in the most likely very mediocre markdown editor
- Commit using your preferred git tool
Requirements: Obsidian installed, git configured
- Clone the repo
- Open
src/as a vault in Obsidian - Do the changes with a kick-ass editor
- Commit using your preferred git tool
To be able to edit the .mdx files you need to install the Obsidian community plugin "mdx as md".
Obsidian also has a very popular Git plugin, if you don't want to do git on the outside.