Incognito-Tech/Incognito-Wiki
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions
Incognito-Wiki/README.md

3.1 KiB
Raw Blame History

Incognito Wiki

This repository contains the public Incognito student wiki, built as a static site with Astro and Starlight. Forgejo hosts the authoritative private repository. Local commands are the source of truth: the project does not depend on Forgejo CI.

Local development

Use Node.js 22.12 or newer and the npm version bundled with Node. Hosted builds are pinned to Node.js 22.22.3. Install dependencies from package.json with:

npm install

Use the checked-in lockfile for a reproducible clean install with npm ci.

  • npm run dev starts the local development server.
  • npm run check runs Astro validation and the Node test suite.
  • npm run verify runs all checks, the content audit, a production build, and the internal-link check.

Maintaining content

Published pages live in src/content/docs/. Add or edit Markdown and MDX there. Navigation is explicit, so add, remove, or move the matching entry manually in src/config/sidebar.mjs whenever a published page changes.

Use these notice conventions exactly for migrated source material:

Historical or potentially outdated information:

:::caution[Historical information]
This information originated in the previous wiki and may be outdated.
:::

An intentionally empty page:

:::note[Awaiting content]
This page is awaiting content.
:::

A source asset that was referenced but not exported (replace the identifier only):

:::danger[Missing source asset]
The previous wiki referenced `source:asset-name.ext`, but that file was not included in the export.
:::

The to-be-studied/ directory is research material, not publication content. Never move it or its contents into src/content/docs/ or public/ without a separate editorial review.

Reviewing the migration

Read docs/migration-report.md when reviewing migrated content. Its source inventory maps every selected DokuWiki source to its destination and records outdated notices, repaired or removed links, missing assets, and significant copy edits. Review the dedicated summaries after the table for unresolved or time-sensitive material, and update the relevant row and summary whenever a migration decision changes.

Deployment

SITE is the public origin and BASE is the path prefix. They are public build settings, not secrets; .env.example documents local defaults. Keep credentials and tokens out of these values and out of the repository.

For a custom domain hosted at its root:

SITE=https://wiki.example.org BASE=/ npm run build

For repository-subpath hosting such as GitHub Pages:

SITE=https://example.github.io BASE=/Incognito-Wiki npm run build

Netlify reads netlify.toml, runs npm run build, and publishes dist. Configure SITE and BASE as environment values for the selected production hostname and path.

The removable workflow at .github/workflows/deploy.yml optionally deploys the GitHub mirror to Pages after a push to main or a manual dispatch. Set the public repository variables SITE_URL and BASE_PATH on GitHub. The workflow is GitHub-specific; Forgejo ignores it, and removing the workflow or netlify.toml does not affect local development or verification.