Skip to content

docs: implement comprehensive documentation website with TypeDoc, getting started, testing, and browser guides #1152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

docs: implement comprehensive documentation website with TypeDoc, getting started, testing, and browser guides #1152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ff91de
Initial plan
Copilot Aug 1, 2025
5dce668
docs: implement comprehensive documentation website
Copilot Aug 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ npm i memfs
## Resources

- Documentation
- **[Complete Documentation](./docs/index.md)** - Comprehensive guides and examples
- **[Getting Started](./docs/getting-started.md)** - Quick start guide with examples
- **[Testing Usage](./docs/testing-usage.md)** - Using memfs in your tests
- **[Browser Usage](./docs/browser-usage.md)** - Running memfs in browsers
- [In-memory Node.js `fs` API](./docs/node/index.md)
- [In-memory browser File System (Access) API](./docs/fsa/fsa.md)
- [`fs` to File System (Access) API adapter](./docs/fsa/fs-to-fsa.md)
Expand Down
Loading