Homepage and Documentation website #58
Open
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 output directories to .gitignore to prevent committed build artifacts and cache from polluting the repository. This keeps the working tree clean and avoids accidental commits of generated files under docs/.vitepress/dist and docs/.vitepress/cache.
Add initial docs package with VitePress dev dependencies and scripts, and create site configuration for documentation under docs/.vitepress. Introduce navigation, sidebar structure with translations, editing, customization, key bindings, advanced and development sections, social link and local search provider. Add a home index.md with hero content, features list, actions and links to translations. These changes provide a structured documentation site scaffold so the project can serve and build documentation using VitePress.
Update image references in French, Portuguese and Spanish i18n README files to use root-relative paths and simplify markdown tables. Replace ../../static/logo-small.png with /logo-small.png and change ../image?raw=true references to root-based paths like /marktext.png, /themeImages/* and /source.gif etc. Adjust table formatting to keep alignment and improve consistency across translations. This ensures images render correctly when served from the site root and reduces broken links in localized documentation.
Add a new workflow (.github/workflows/deploy.yml) that builds and deploys the VitePress documentation from the docs/ directory to GitHub Pages. Key changes: - Trigger on pushes to main and manual workflow_dispatch; watch docs/** and the workflow file itself. - Configure GITHUB_TOKEN permissions for Pages deployment (pages: write, contents: read, id-token: write). - Add concurrency group to avoid overlapping deployments while allowing in-progress runs to finish. - Build job: checkout repo, setup Node (v24) with npm cache, install dependencies in docs/, and build site with npm run docs:build. - Upload built site artifact from docs/.vitepress/dist. - Deploy job: configure pages environment and deploy artifact using actions/deploy-pages@v4. Reason: Automate site build and deployment to GitHub Pages to ensure the docs are published on changes to the docs or when manually triggered.
Update VitePress config to use /marktext as the base path instead of /docs. This asset and route resolution when the site is deployed under the /marktext subpath, preventing broken links and incorrect resource loading.
Add a generated package-lock.json under docs to lock dev dependencies used by the documentation site (VitePress and related packages). This commit captures exact package versions and integrity hashes so that installations of the docs environment are deterministic across machines and CI.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Context: #50
A homepage and docs website for marktext.
/docsusing github actionstkaixiang.github.io/marktexturl after merging PR