microsoft / microsoft/fabricnotes
Website features
Open
@cmaneu is already working on this.
Since May 17, 2023.
build
- Dominant language
- CSS
- Stars
- 118
- Forks
- 31
- Avg merge
- 4d 13h
- Merged PRs (30d)
- 1
Description
All the notes are in the /notes directory, with several files:
{note-name}.png: The original, high-resolution note image{note-name}.md: The metadata and intro text for that note
We want to generate a website out of these notes, with the following requirements:
- A home page That displays miniatures of all images
- A post page for each notes that displays the note itself and the markdown content.
- It should also display a "previous" and "next" button
This website will be hosted on GitHub Pages.
### Features
- [x] Build home page, when clicking display the image directly
- [x] Create GitHub Action to deploy ( /w tailwindcss CLI)
- [x] Add clarity
- [x] Issues templates
- [x] Optimize image sizes (srcset, webp, ...)
### Future ideas
- [ ] Support featured notes
- [ ] Download all notes as PDF
- [ ] Build Note page, update index generation (links)
- [ ] Download current as PDF
- [ ] Push notifications
- [ ] Collections (5min intro, Fabric for Data Scientists, etc...)
- [ ] Pagination for the home page (do not display all of them)
- [ ] SEO?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.