Skip to content

Commit 31ba40c

Browse files
lwasserflpmJimMadgedependabot[bot]allcontributors[bot]
authored
feat(docs): New astro site to replace the dated Docusaurus infra ✨ (#938)
* docs: remove Docusaurus website and docs * docs: remove netlify.toml * docs: add astro config * docs: add astro / starlight docs source * docs: add public all-contrib static files * docs: dependencies, update package.json * docs: added favicons and related images * docs update node version in .nvmrc; remove .astro; fix .gitignore * docs: small updates to github CI * docs: update .gitignore with more astro related files * docs: small updates to clarify config * chore(link checker): Move to Lychee for link checking (#889) * chore(package.json): add angular commit helper deps and script * test(link checking): add lychee configuration re #852 * test(link check): add script to check links in Markdown source * fix: correct link to eslint commit convention * fix: correct bot usage image path * test: add mdx to fallback extentions * fix: remove broken link * test: check links internal to a page * test: add root dir to link checking This ensures links to an absolute path (starting with '/') are directed to the public directory. fix 852 * ci: add markdownlint dep and script * style: fix linting errors * ci: install deps for lint workflow * ci: add offline link check for PRs and push to main This workflow will only check links to local files and not make network requests. There should therefore be no false negatives and it is safer to use as a required CI item. * docs: add landing page to astro documentation (#887) docs: make index dynamic and add images docs: lint all docs and add markdown lint dep docs: lint Correct image path * docs:remove placeholder index page (#899) docs:remove placeholder index page * docs: style landing page, add branded fonts and colors & tailwind (#901) * docs(style): source gfonts poppins * docs(style): add custom style/ setup tailwind * docs(img): add and update images * docs(img): add and update images * docs(config): cleanup landing and config * chore(deps): update to support tailwind * chore(css): setup tailwind css * docs: add graphics for home page and style buttons * docs: add buttons * docs: missed a few more image updates * chore(deps): correct dependency location in package.lock * chore(clean): clean old files * chore: add poppins font license --------- Co-authored-by: Jim Madge <[email protected]> * docs: add documentation for mdx pages and update images for the overview section (#915) * docs: update images and document how to add content to our docs docs: update images and edit text for all intro pages docs: clean up all pages in the general overview section docs: add description for Ideas, projectManagement and promotion (#829) docs: ✏️ Add dark mode README logo (#741) Co-authored-by: Leah Wasser <[email protected]> Co-authored-by: Jim Madge <[email protected]> * enh(image): bring in dark mode compatible logo * docs: tidy adding images section Move path alias section up and adjust Apply suggestions from code review Co-authored-by: Jim Madge <[email protected]> * style: linting fixes for emoji table and other content --------- Co-authored-by: Jim Madge <[email protected]> Co-authored-by: Jim Madge <[email protected]> * chore(ci for docs): Get docs online via github pages (#914) * docs: get docs online via github pages new branch * chore: set site and base according to astro docs Astro docs: https://docs.astro.build/en/guides/deploy/github/#how-to-deploy suggest how to specifiy the site url and base for GitHub pages. --------- Co-authored-by: Jim Madge <[email protected]> * docs(fix basurl): update baseurl to support github pages (#924) * chore(ci): Fix offline link check (#923) * ci: correct workflow file format 🤦 * ci: add root directory to offline link check This ensures that the link checkers knows where to look for absolute links. * docs: update images and breakout links for the "bot" section of the documentation (#919) * docs: update images and document how to add content to our docs docs: update images and edit text for all intro pages docs: clean up all pages in the general overview section docs: add description for Ideas, projectManagement and promotion (#829) docs: ✏️ Add dark mode README logo (#741) Co-authored-by: Leah Wasser <[email protected]> Co-authored-by: Jim Madge <[email protected]> * enh(image): bring in dark mode compatible logo * docs: tidy adding images section Move path alias section up and adjust Apply suggestions from code review Co-authored-by: Jim Madge <[email protected]> * style: linting fixes for emoji table and other content * docs: fix links and breakouts in bot section * Apply suggestions from code review Co-authored-by: Jim Madge <[email protected]> --------- Co-authored-by: Jim Madge <[email protected]> Co-authored-by: Jim Madge <[email protected]> * docs: add Netlify badge to home page (#927) docs: add netlify badge for open source plan * docs: import styles globally rather than inline in a file (#933) docs(styles): apply stylesheets globally docs: document custom styles * Docs: Fix images and links in the last sections of the docs (#931) docs: fix links and images on last sections * chore: add merge commit to handle merge conflicts when we merge into main (#929) * chore(ci): add dependabot config for actions (#865) * chore(ci): bump actions/checkout from 3 to 5 (#883) Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 5. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v3...v5) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: '5' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(ci): bump actions/setup-node from 3 to 4 (#882) Bumps [actions/setup-node](https://github.com/actions/setup-node) from 3 to 4. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](actions/setup-node@v3...v4) --- updated-dependencies: - dependency-name: actions/setup-node dependency-version: '4' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(ci): bump actions/upload-pages-artifact from 3 to 4 (#881) * chore(ci): bump actions/upload-pages-artifact from 3 to 4 Bumps [actions/upload-pages-artifact](https://github.com/actions/upload-pages-artifact) from 3 to 4. - [Release notes](https://github.com/actions/upload-pages-artifact/releases) - [Commits](actions/upload-pages-artifact@v3...v4) --- updated-dependencies: - dependency-name: actions/upload-pages-artifact dependency-version: '4' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> * Update .github/workflows/build-website.yml * chore(ci): update actions --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Leah Wasser <[email protected]> * chore(branch rename): rename master --> main throughout so ci runs and docs are correct (#890) chore(rename master to main branch): we renamed the master branch; this updates all actions & docs * docs: ✏️ fix links to doc site and small bug in footer.js (#871) * docs: ✏️ fix links to doc site and small bug in footer.js This change fixes an error in the footer and also updates some broken links. ✅ Closes: 870 * Update website/static/index.html Co-authored-by: Leah Wasser <[email protected]> * Update docs/overview.md --------- Co-authored-by: Jim Madge <[email protected]> * docs: add JimMadge as a contributor for review (#892) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Leah Wasser <[email protected]> * docs: add JHWelch as a contributor for doc (#894) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add lwasser as a contributor for review (#897) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add JimMadge as a contributor for infra (#896) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Jim Madge <[email protected]> * docs: ✏️ Add dark mode README logo (#741) Co-authored-by: Leah Wasser <[email protected]> Co-authored-by: Jim Madge <[email protected]> * docs: add RichLewis007 as a contributor for bug, and doc (#906) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add parthamk as a contributor for doc (#909) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add rebeccaringuette as a contributor for ideas (#910) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * Change build branch from 'master' to 'docs-upgrade' * docs: add description for Ideas, projectManagement and promotion (#829) * docs: add KhushiPandey8 as a contributor for doc (#918) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add lwasser as a contributor for doc (#921) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add JimMadge as a contributor for doc (#922) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: linting fix * docs: remove last docusaurus files * docs: update * chore: fix linting step to handle mdx * chore: lint * fix: links --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Jim Madge <[email protected]> Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Jim Madge <[email protected]> Co-authored-by: Jordan Welch <[email protected]> Co-authored-by: Reshama Shaikh <[email protected]> * chore: add dot files to ignore * Apply suggestion from @JimMadge Co-authored-by: Jim Madge <[email protected]> * chore: linting chore: docusaurus came back --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Felipe Moreno <[email protected]> Co-authored-by: Jim Madge <[email protected]> Co-authored-by: Jim Madge <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Jordan Welch <[email protected]> Co-authored-by: Reshama Shaikh <[email protected]>
1 parent 76ca8c4 commit 31ba40c

File tree

135 files changed

+9017
-20214
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

135 files changed

+9017
-20214
lines changed

‎.github/workflows/build-website.yml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,31 +3,31 @@ name: Deploy to GitHub Pages
33
on:
44
push:
55
branches:
6-
- main
6+
- docs-upgrade
77
jobs:
88
build:
9-
name: Build Docusaurus
9+
name: Build Astro site
1010
runs-on: ubuntu-latest
1111
steps:
12-
- uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
12+
- uses: /actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
1313
with:
1414
fetch-depth: 0
1515
- uses: actions/setup-node@dbe1369d7be17e7823f8c1ee1ae8bec5779239dd # v3.9.0
1616
with:
17-
node-version: 22
17+
node-version: 23
1818
cache: npm
1919

2020
- name: Install dependencies
2121
run: npm ci
2222
- name: Build website
2323
run: |
2424
npm run build
25-
ls website/build
25+
ls dist/
2626
2727
- name: Upload Build Artifact
2828
uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
2929
with:
30-
path: website/build/all-contributors
30+
path: dist/
3131
deploy:
3232
name: Deploy to GitHub Pages
3333
needs: build

‎.github/workflows/lint.yml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,6 @@ jobs:
1414
runs-on: ubuntu-latest
1515
steps:
1616
- uses: actions/checkout@v5
17-
- uses: actions/setup-node@v4
18-
- run: npx --package markdownlint-cli markdownlint **/*.md --ignore node_modules
17+
- uses: actions/setup-node@v5
18+
- run: npm ci
19+
- run: npm run lint

‎.github/workflows/offline-link-check.yml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Offline link check
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
9+
jobs:
10+
link_check:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v5
14+
- uses: lycheeverse/lychee-action@v2
15+
with:
16+
# Only check local files, no network requests
17+
args: --config './lychee.toml' --no-progress --offline --root-dir "$GITHUB_WORKSPACE/public/" 'src/content/docs/**/*.md'
18+
# Fail job when lychee returns a non-zero exit code
19+
fail: true

‎.gitignore‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,20 @@ node_modules
2525
logs
2626
*.log
2727
npm-debug.log*
28+
yarn-debug.log*
29+
yarn-error.log*
30+
pnpm-debug.log*
2831

29-
# Website
30-
website/build
31-
website/i18n
32-
website/translated_docs
32+
# Astro build output
33+
dist
34+
35+
# Astro generated types
36+
.astro/
37+
38+
39+
.lycheecache
40+
dist/
41+
42+
# environment variables
43+
.env
44+
.env.production

‎.netlify/state.json‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎.nvmrc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
16.17.0
1+
23.3.0

‎CONTRIBUTING.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22

33
We welcome contributions of all kinds to AllContributors.
44

5-
## 13 August 2025 Update:
5+
## 1 September 2025 Update:
66

7-
Currently, we are doing some work to revive the project. The documentation
8-
website is not online but we are working to get it online soon.
7+
Currently, we are doing some work to revive the project. The documentation online but some of the content (specifically the translations) are not working as expected.
98

109
************* THE LINKS BELOW DON'T CURRENTLY WORK ******
1110

‎README.md‎

Lines changed: 22 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,24 @@
1-
> Call for translators! [We're looking for translators](https://github.com/all-contributors/all-contributors/issues/143) to help translate this spec for everyone!
1+
# Welcome to the All Contributors website repository
22

3-
<div align="center">
4-
<a href="https://allcontributors.org">
5-
<img src="docs/assets/logo-full.svg" alt="✨ All Contributors ✨" width="800px" />
6-
</a>
7-
</div>
3+
[![✨ All Contributors ✨](src/assets/logo-full.svg)](https://allcontributors.org)
84

9-
<table>
10-
<caption>Read this documentation in the following languages</caption>
11-
<tbody>
12-
<tr>
13-
<td><a href="https://allcontributors.org/docs/ko/overview">한국어</a></td>
14-
<td><a href="https://allcontributors.org/docs/zh-CN/overview">中文</a></td>
15-
<td><a href="https://allcontributors.org/docs/id/overview">Bahasa Indonesia</a></td>
16-
<td><a href="https://allcontributors.org/docs/de/overview">Deutsch</a></td>
17-
<td><a href="https://allcontributors.org/docs/pl/overview">Polski</a></td>
18-
</tr>
19-
<tr>
20-
<td><a href="https://allcontributors.org/docs/en/overview">English</a></td>
21-
<td><a href="https://allcontributors.org/docs/pt-BR/overview">Português do Brasil</a></td>
22-
<td><a href="https://allcontributors.org/docs/es-ES/overview">Español</a></td>
23-
<td><a href="https://allcontributors.org/docs/fr/overview">Français</a></td>
24-
<td><a href="https://allcontributors.org/docs/ru/overview">Русский</a></td>
25-
<td><a href="https://allcontributors.org/docs/ja/overview">日本語</a></td>
26-
</tr>
27-
</tbody>
28-
</table>
5+
> Call for translators! [We're looking for translators](https://github.com/all-contributors/all-contributors/issues/143) to help translate this spec for everyone!
6+
7+
**Read our documentation in the following languages:**
8+
9+
| Language | Link |
10+
|-------------------------|---------------------------------------------------------------------|
11+
| 한국어 | [한국어](https://allcontributors.org/docs/ko/overview) |
12+
| 中文 | [中文](https://allcontributors.org/docs/zh-CN/overview) |
13+
| Bahasa Indonesia | [Bahasa Indonesia](https://allcontributors.org/docs/id/overview) |
14+
| Deutsch | [Deutsch](https://allcontributors.org/docs/de/overview) |
15+
| Polski | [Polski](https://allcontributors.org/docs/pl/overview) |
16+
| English | [English](https://allcontributors.org/docs/en/overview) |
17+
| Português do Brasil | [Português do Brasil](https://allcontributors.org/docs/pt-BR/overview) |
18+
| Español | [Español](https://allcontributors.org/docs/es-ES/overview) |
19+
| Français | [Français](https://allcontributors.org/docs/fr/overview) |
20+
| Русский | [Русский](https://allcontributors.org/docs/ru/overview) |
21+
| 日本語 | [日本語](https://allcontributors.org/docs/ja/overview) |
2922

3023
[![Build Status](https://img.shields.io/circleci/project/all-contributors/all-contributors/main.svg)](https://circleci.com/gh/all-contributors/workflows/all-contributors/tree/main)
3124
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/all-contributors/localized.svg)](https://crowdin.com/project/all-contributors)
@@ -43,10 +36,9 @@ People are giving themselves and their free time to contribute to open source pr
4336

4437
## The All Contributors Table
4538

46-
Below is an example of how using the all-contributors spec table can recognize all contributors
47-
<div align="center">
48-
<img src="docs/assets/contributors-table-small.png" alt="All Contributors Table Screenshot" width="800px" />
49-
</div>
39+
Below is an example of how using the all-contributors spec table can recognize all contributors.
40+
41+
![All Contributors Table Screenshot](src/assets/contributors-table-small.png)
5042

5143
> You can use [the @all-contributors bot 🤖](https://allcontributors.org/docs/en/bot/overview) to automate acknowledging contributors to your open source projects
5244

‎astro.config.mjs‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
// @ts-check
2+
import { defineConfig } from 'astro/config';
3+
import starlight from '@astrojs/starlight';
4+
import sitemap from '@astrojs/sitemap';
5+
import tailwindcss from '@tailwindcss/vite';
6+
7+
export default defineConfig({
8+
site: 'https://all-contributors.github.io',
9+
base: '',
10+
output: 'static',
11+
12+
redirects: {
13+
// Later we can put redirects here if needed
14+
},
15+
16+
integrations: [
17+
starlight({
18+
customCss: [
19+
'./src/styles/global.css',
20+
'./src/fonts/font-face.css',
21+
],
22+
title: '',
23+
logo: {
24+
src: './src/assets/logo-full.svg',
25+
},
26+
favicon: '/icons/favicon-16x16.png',
27+
social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/all-contributors/all-contributors' }],
28+
sidebar: [
29+
{
30+
label: 'Specification',
31+
items: [
32+
{ label: 'spec overview', slug: 'overview' },
33+
{ label: 'specification', slug: 'specification' },
34+
{ label: 'emoji-key', slug: 'emoji-key' },
35+
{ label: 'usage tips', slug: 'usage-tips' },
36+
{ label: 'tooling', slug: 'tooling' }
37+
],
38+
},
39+
{
40+
label: '@all-contributors Bot 🤖',
41+
items: [
42+
{ label: 'bot overview', slug: 'bot/overview' },
43+
{ label: 'installation', slug: 'bot/installation' },
44+
{ label: 'usage', slug: 'bot/usage' },
45+
{ label: 'configuration', slug: 'bot/configuration' },
46+
{ label: 'faq', slug: 'bot/faq' }
47+
],
48+
},
49+
{
50+
label: 'CLI',
51+
items: [
52+
{ label: 'CLI overview', slug: 'cli/overview' },
53+
{ label: 'installation', slug: 'cli/installation' },
54+
{ label: 'usage', slug: 'cli/usage' },
55+
{ label: 'configuration', slug: 'cli/configuration' }
56+
],
57+
},
58+
{
59+
label: 'Project',
60+
items: [
61+
{ label: 'contribute', slug: 'project/contribute' },
62+
{ label: 'development', slug: 'project/development' },
63+
{ label: 'code-of-conduct', slug: 'project/code-of-conduct' },
64+
{ label: 'implementations', slug: 'project/implementations' },
65+
],
66+
},
67+
],
68+
}), sitemap()],
69+
70+
vite: {
71+
plugins: [tailwindcss()],
72+
resolve: {
73+
alias: {
74+
'@assets': '/src/assets',
75+
},
76+
},
77+
},
78+
});

‎docs/bot/overview.md‎

Lines changed: 0 additions & 26 deletions
This file was deleted.

0 commit comments

Comments
 (0)