AREA44 / fancy-notes

Fany notes about all kinds of interesting topics

Fancy Notes!

This is a site collecting useful notes about anything you are finding. It is more than just a note-taking site. It’s a community of learners and doers who value useful notes and want to improve their skills and knowledge. Whether you’re a student, a professional, a hobbyist, or just someone who enjoys learning new things, this site is for you. Join us today and start collecting some notes about useful notes!

Fancy Notes is built using Nextra - a simple, powerful and flexible site generation framework with everything you love from Next.js

Local development

git clone --depth=1 https://github.com/AREA44/fancy-notes
cd fancy-notes
bun install
bun run dev

Now the site live at http://localhost:3000

Creating a Note

To create a new note in Fancy Notes, follow these steps:

1. Navigate to the pages directory in the project's root folder.
2. Create a new .mdx file with a unique name for your note.
3. Open the newly created file in a text editor of your choice.
4. Add your note content using MDX syntax. All images, videos, etc should be save in the public directory.
5. Don't forget to save the file once you've finished adding your note content.

For better organization and metadata management, don't forget to edit the corresponding _meta.json file in the pages directory. This file allows you to specify additional information about your note, such as title, categories, tags, and other relevant metadata.

Once you've created and saved your note, it will be available for viewing and searching within the Fancy Notes website.

Contributing

We welcome contributions from the community to enhance Fancy Notes. If you'd like to contribute, please follow these steps:

1. Fork the repository from GitHub.
2. Create a new branch for your feature or bug fix.
3. Make your changes and ensure they are thoroughly tested.
4. Commit your changes and push them to your forked repository.
5. Create a pull request, providing a detailed description of your changes.

We appreciate your contributions!

License

Fancy Notes is released under the MIT License.