Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .github/workflows/create-plugin-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ jobs:
steps:
- uses: actions/github-script@v9
with:
retries: 3
script: |
const body = context.payload.issue.body ?? '';
const issueNumber = context.payload.issue.number;
Expand Down
5 changes: 5 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,11 @@ jobs:
with:
ref: ${{ github.event.pull_request.head.sha || github.ref }}
fetch-depth: 0
persist-credentials: false
# Deploy from fork PRs only runs after a maintainer explicitly adds the
# '🚀request-deploy' label (gated by the job's `if` condition above), so
# opting in to fork checkout here is an intentional, reviewed trust boundary.
allow-unsafe-pr-checkout: true

- name: Remove built-in Yarn
run: npm uninstall -g yarn
Expand Down
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,24 @@ yarn build

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Community homepage and theme

The [homepage](src/pages/index.tsx) highlights the knowledge base, plugin directory, and ways to
contribute. Its curated notebook and topic links point to existing community content; update these
alongside the content they feature. Keep recommendations descriptive rather than implying popularity
or endorsement.

[Homepage styles](src/pages/index.module.scss) use the shared `--cp-*` palette in
[the community theme](src/scss/_community-theme.scss), which is loaded after the existing custom
styles. The shared theme maps those tokens to Infima so documentation and the plugin directory use
the same visual language without replacing their layouts. Existing admonition and syntax-highlighting
colours retain their semantic meaning.

Docusaurus owns theme detection and persistence, including the native light/dark switch and operating
system preference. Avoid adding a separate theme-detection script that would compete with it.
Keep keyboard focus visible, respect reduced-motion preferences, and check both themes at mobile and
desktop widths when changing the design. Run `yarn typecheck` and `yarn build` before submitting changes.

## Deployment

Using SSH:
Expand Down
20 changes: 14 additions & 6 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ const commonDocsPluginConfig = {
/** @type {import('@docusaurus/types').Config} */
const config: Config = {
title: 'Docusaurus.community',
tagline: 'Docusaurus community knowledge sharing and plugin directory.',
tagline: 'Guides, plugins, and components shared by Docusaurus users.',
favicon: 'img/favicon.ico',
url: 'https://docusaurus.community',
baseUrl: '/',
Expand Down Expand Up @@ -119,7 +119,7 @@ const config: Config = {
alt: 'Docusaurus.community Logo',
src: 'img/logo.svg',
},
hideOnScroll: true,
hideOnScroll: false,
items: [
{
type: 'doc',
Expand All @@ -145,28 +145,24 @@ const config: Config = {
label: 'Sponsor',
position: 'right',
target: '_blank',
className: 'sponsorship-link',
},
{
to: 'https://docusaurus.io',
label: 'Docusaurus',
position: 'right',
target: '_blank',
className: 'docusaurus-link',
},
{
to: 'https://discord.gg/docusaurus',
label: 'Discord',
position: 'right',
target: '_blank',
className: 'discord-link',
},
{
to: 'https://github.com/DocusaurusCommunity/website',
label: 'GitHub',
position: 'right',
target: '_blank',
className: 'github-link',
},
],
},
Expand All @@ -187,6 +183,18 @@ const config: Config = {
label: 'Knowledge',
to: '/knowledge/',
},
{
label: 'Plugin directory',
to: '/plugindirectory/',
},
{
label: 'Contribute a guide',
to: '/contributing/customisations/',
},
{
label: 'Add a plugin',
to: '/contributing/plugins/',
},
],
},
{
Expand Down
Loading
Loading