https://github.com/area44/fancy-notes

Fany notes about all kinds of interesting topics
https://github.com/area44/fancy-notes

nextjs nextra notes

Last synced: 14 days ago
JSON representation

Fany notes about all kinds of interesting topics

• Host: GitHub
• URL: https://github.com/area44/fancy-notes
• Owner: AREA44
• License: mit
• Created: 2023-03-01T20:33:25.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-27T21:01:42.000Z (24 days ago)
• Last Synced: 2024-10-28T07:28:45.235Z (23 days ago)
• Topics: nextjs, nextra, notes
• Language: MDX
• Homepage: https://fancy-notes.vercel.app
• Size: 1.81 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![banner](./public/og.svg)

# 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](https://github.com/AREA44/fancy-notes) today and start collecting some notes about useful notes!

Fancy Notes is built using [Nextra](https://nextra.site) - a simple, powerful and flexible site generation framework with everything you love from Next.js

## Local development

```bash

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](https://github.com/AREA44/fancy-notes).

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](LICENSE).