Contributing
If you would like to contribute to confluence-markdown-exporter, please read the contribution guideline in the repository.
Reporting issues
Use the GitHub issue tracker. When reporting, include:
- Your Confluence flavour and version (Cloud, Server, Data Center)
- The exact command you ran
- The full output with
cme config set export.log_level=DEBUGenabled - A minimal page (if possible) reproducing the issue
Docs site
The documentation site is built with Docusaurus and deployed to GitHub Pages.
- Sources live under
docs/in the repository as plain Markdown / MDX. - Local preview:
npm ci && npm start(serveshttp://localhost:3000/confluence-markdown-exporter/). - Production build with all versions:
npm run build:versionedthennpm run serve.
Versioning
Versioning is driven by git release tags. There are no versioned_docs/ folders committed to the repo. At build time, scripts/build-versions.mjs:
- Lists git tags matching
^\d+\.\d+\.\d+$(the project's release pattern). - Filters to tags whose tree already contains a Docusaurus
docs/+sidebars.ts. - Snapshots each eligible tag into
versioned_docs/version-<tag>/by checking out that tag's docs and runningdocusaurus docs:version. - Builds with the newest tag set as the default version; HEAD becomes the
Next 🚧(unreleased) version.
That means: cutting a new release tag automatically produces a new docs version on the next site build. Old versions cannot be edited after-the-fact; they are sourced directly from their git tag.
License
This tool is an open source project released under the MIT License.