Add comprehensive documentation site with VitePress #101
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add VitePress configuration and theme setup - Add main documentation home page with feature highlights - Add logo and public assets
- Add detailed API reference with examples for all core functions - Include format(), parse(), subtract(), and other function docs - Add FormatterOptions and ParserOptions documentation - Include format tokens reference and usage examples
- Add detailed installation guide with package manager options - Include import methods for ES modules and CommonJS - Add quick start guide with common usage patterns - Include examples for locales, timezones, and date arithmetic
- Add complete list of 40+ supported locales with import examples - Add comprehensive timezone reference with 400+ IANA timezones - Include proper TypeScript import statements for all modules - Organize by regions (Africa, America, Asia, Europe, etc.)
- Add automated VitePress site deployment to GitHub Pages - Configure workflow to trigger on docs changes and manual dispatch - Set up proper permissions and artifact handling - Enable automatic documentation publishing on master branch
- Update homepage URL to point to GitHub Pages documentation - Version bump to 4.0.3 - Update dependencies for documentation tooling
- Simplify ESLint configuration by removing unused globals - Update logo.png for documentation site - Add docs build artifacts to .gitignore
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Changes
Test plan
npm run docs:build