A tool to write beautiful markdown with code snippet capability
If you are new to Markdown Syntax use this as a guide: Markdown Basic Syntax
Clone the repository or fork
git clone <url>
Install packages and dependecies
npm i && npm run dev
-
Enter a Title for your new note
-
Write markdown into the Note box where it says "Add a Note"
-
Select a coding language
-
Enter line numbers you'd like to highlight in the following format:
To highlight a single line enter a line number followed by a:then the same number again. When highlighting multiple lines they need to be separated by a,
1:1 // -> highlights the first line only
1:1, 3:5 // -> highlights the first line, and third through fifth line.
You can copy your code snippets by clicking the copy button below each one
Documents are called Notes.
Top section will be your code snippets
Below that section will be your markdown notes.
Note
The Title when creating your notes will not show up on this page. If you want your Notes to have a title please add it using markdown for example:
# This is my Title
User authentication is not implemented yet due to time constraints. Will implement in the next coming weeks. - 06/20/2024
Currently styling is done primarily with CSS stylesheets. I'm planning to replace these with TailwindCSS.
When writing a code snippet in the Create Docs page it doesn't incorporate tabbing and autocomplete for coding syntax. This will be added soon.
Automated code analysis to generate basic documentation that can then be adjusted as needed. This documentation should be able to generate docs explaining core functionalities such as:
- functions
- parameters
- React components
React w/ Vite
NodeJS w/ Express
documentsAPI created specifically for Simple Docu
MongoDB Database Storage
Remarkable for Markdown Rendering
React Code Block for Code Snippets
Heart by Chamestudio on IconScout