Skip to content

Commit d8d844b

Browse files
committed
Chore(Dev tools): Edit Readme
1 parent cfce7c5 commit d8d844b

File tree

2 files changed

+24
-4
lines changed

2 files changed

+24
-4
lines changed

.husky/pre-commit

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@ cd $ULLD_DEV_ROOT
22

33
branch="$(git rev-parse --abbrev-ref HEAD)"
44

5-
if [ "$branch" = "main" ]; then
6-
echo "Don't commit directly to the main branch ace."
7-
exit 1
8-
fi
95

106
dotenvx ext precommit
117

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
11
# Uh Little Less Dum
22

33
_Forever free, perpetually open source note taking._
4+
5+
- [x] Write your notes in modern markdown, [mdx](https://mdxjs.com). All of the simplicity of markdown with the ability to embed entire react components.
6+
- [x] Take advantage of mdx by embedding:
7+
- [x] Videos with the ability to link to specific time stamps elsewhere in your notes.
8+
- [x] Images through a vastly extended Image component, while still supporting the native markdown image syntax.
9+
- [x] Interactive tabular data in table form
10+
- [x] Interactive, 2d and 3d plots (Rewrite in progress. Currently in beta but will be available in the coming weeks)
11+
- [x] Juyter cells
12+
- [x] Pdf's
13+
- [ ] Interactive modals, sidebars and more.
14+
- [x] An integrated bibliography manager with search functionality and the ability to link directly to PDFs.
15+
- [x] An integrated snippets database
16+
- [x] An integrated equations database with added support for embedding, searching by equation, linking snippets to equations and more.
17+
- [x] Jupyter cells and notebooks, either embedded within a mdx note or as a standalone component.
18+
- [x] Pdf's, both embedded directly within a note or as a standalone component with support for multiple views
19+
- [ ] While linking an mdx note to a PDF is currently very straightforward, an improved annotation experience is planned for the near future.
20+
- [x] During the conversion of this framework from a personal tool to an open sources framework, my focus was on the ease of extensibility. Anyone familiar with React, Node, or even just Css can extend this app by creating their own plugin, and simplying adding that plugin to their configuration file. Developers can add:
21+
- [ ] Embeddable components
22+
- [ ] Slot components (Override existing components that appear elsewhere in the app, outside of a user's note)
23+
- [ ] Command palette actions
24+
- [ ] Parsers to extend the syntax of Mdx
25+
- [ ] And much more! Because all components are rendered on the server by default, adding your own server-side related features are as simple as creating a React server component.
26+
27+
Learn more by visiting our website at [UhLittleLessDum.com](https://uhlittlelessdum.com), and if you're curious, check out my notes on the model that inspired this application as part of the demo for this application [here](https://uhlittlelessdum.com/myWork).

0 commit comments

Comments
 (0)