Skip to content

Commit c6740a7

Browse files
committed
add deploy config
1 parent 8439110 commit c6740a7

File tree

3 files changed

+182
-131
lines changed

3 files changed

+182
-131
lines changed

.github/workflows/deploy.yml

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
# Review gh actions docs if you want to further define triggers, paths, etc
8+
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
9+
10+
jobs:
11+
build:
12+
name: Build Docusaurus
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
with:
17+
fetch-depth: 0
18+
- uses: actions/setup-node@v4
19+
with:
20+
node-version: 18
21+
cache: npm
22+
23+
- name: Install dependencies
24+
run: npm ci
25+
- name: Build website
26+
run: npm run build
27+
28+
- name: Upload Build Artifact
29+
uses: actions/upload-pages-artifact@v3
30+
with:
31+
path: build
32+
33+
deploy:
34+
name: Deploy to GitHub Pages
35+
needs: build
36+
37+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
38+
permissions:
39+
pages: write # to deploy to Pages
40+
id-token: write # to verify the deployment originates from an appropriate source
41+
42+
# Deploy to the github-pages environment
43+
environment:
44+
name: github-pages
45+
url: ${{ steps.deployment.outputs.page_url }}
46+
47+
runs-on: ubuntu-latest
48+
steps:
49+
- name: Deploy to GitHub Pages
50+
id: deployment
51+
uses: actions/deploy-pages@v4

docs/intro.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Este manual está organizado nas seguintes seções:
2121
- **[Espaços culturais](/docs/espacos-culturais)**: Mapeamento e gestão de espaços culturais
2222
- **[Eventos](/docs/eventos)**: Divulgação e gestão de eventos culturais
2323
- **[Oportunidades](/docs/oportunidades)**: Criação e gestão de editais e chamadas públicas
24-
- **[Dúvidas Frequentes e como contribuir](/docs/duvidas-frequentes-e-como-contribuir)**: Respostas para perguntas comuns e informações sobre como contribuir
24+
- **[Dúvidas Frequentes e como contribuir](/docs/duvidas-frequentes)**: Respostas para perguntas comuns e informações sobre como contribuir
2525
- **[Referências](/docs/referencias)**: Recursos adicionais e materiais complementares
2626

2727
## Como usar este Manual
@@ -32,4 +32,4 @@ Se você está começando agora, recomendamos seguir a ordem das seções aprese
3232

3333
## Contribuindo com este Manual
3434

35-
Este manual é um documento vivo, em constante evolução. Se você encontrar informações desatualizadas ou quiser contribuir com novos conteúdos, consulte a seção [Dúvidas Frequentes e como contribuir](/docs/duvidas-frequentes-e-como-contribuir) para saber como proceder.
35+
Este manual é um documento vivo, em constante evolução. Se você encontrar informações desatualizadas ou quiser contribuir com novos conteúdos, consulte a seção [Dúvidas Frequentes e como contribuir](/docs/duvidas-frequentes) para saber como proceder.

docusaurus.config.ts

+129-129
Original file line numberDiff line numberDiff line change
@@ -1,143 +1,143 @@
1-
import {themes as prismThemes} from 'prism-react-renderer';
2-
import type {Config} from '@docusaurus/types';
1+
import { themes as prismThemes } from 'prism-react-renderer';
2+
import type { Config } from '@docusaurus/types';
33
import type * as Preset from '@docusaurus/preset-classic';
44

55
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
66

77
const config: Config = {
8-
title: 'My Site',
9-
tagline: 'Dinosaurs are cool',
10-
favicon: 'img/favicon.ico',
8+
title: 'My Site',
9+
tagline: 'Dinosaurs are cool',
10+
favicon: 'img/favicon.ico',
1111

12-
// Set the production url of your site here
13-
url: 'https://your-docusaurus-site.example.com',
14-
// Set the /<baseUrl>/ pathname under which your site is served
15-
// For GitHub pages deployment, it is often '/<projectName>/'
16-
baseUrl: '/',
12+
// Set the production url of your site here
13+
url: 'https://your-docusaurus-site.example.com',
14+
// Set the /<baseUrl>/ pathname under which your site is served
15+
// For GitHub pages deployment, it is often '/<projectName>/'
16+
baseUrl: '/',
1717

18-
// GitHub pages deployment config.
19-
// If you aren't using GitHub pages, you don't need these.
20-
organizationName: 'facebook', // Usually your GitHub org/user name.
21-
projectName: 'docusaurus', // Usually your repo name.
18+
// GitHub pages deployment config.
19+
// If you aren't using GitHub pages, you don't need these.
20+
organizationName: 'redemapas', // Usually your GitHub org/user name.
21+
projectName: 'manual', // Usually your repo name.
2222

23-
onBrokenLinks: 'throw',
24-
onBrokenMarkdownLinks: 'warn',
23+
onBrokenLinks: 'throw',
24+
onBrokenMarkdownLinks: 'warn',
2525

26-
// Even if you don't use internationalization, you can use this field to set
27-
// useful metadata like html lang. For example, if your site is Chinese, you
28-
// may want to replace "en" with "zh-Hans".
29-
i18n: {
30-
defaultLocale: 'en',
31-
locales: ['en'],
32-
},
26+
// Even if you don't use internationalization, you can use this field to set
27+
// useful metadata like html lang. For example, if your site is Chinese, you
28+
// may want to replace "en" with "zh-Hans".
29+
i18n: {
30+
defaultLocale: 'en',
31+
locales: ['en'],
32+
},
3333

34-
presets: [
35-
[
36-
'classic',
37-
{
38-
docs: {
39-
sidebarPath: './sidebars.ts',
40-
// Please change this to your repo.
41-
// Remove this to remove the "edit this page" links.
42-
editUrl:
43-
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
44-
},
45-
blog: {
46-
showReadingTime: true,
47-
feedOptions: {
48-
type: ['rss', 'atom'],
49-
xslt: true,
50-
},
51-
// Please change this to your repo.
52-
// Remove this to remove the "edit this page" links.
53-
editUrl:
54-
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
55-
// Useful options to enforce blogging best practices
56-
onInlineTags: 'warn',
57-
onInlineAuthors: 'warn',
58-
onUntruncatedBlogPosts: 'warn',
59-
},
60-
theme: {
61-
customCss: './src/css/custom.css',
62-
},
63-
} satisfies Preset.Options,
64-
],
65-
],
34+
presets: [
35+
[
36+
'classic',
37+
{
38+
docs: {
39+
sidebarPath: './sidebars.ts',
40+
// Please change this to your repo.
41+
// Remove this to remove the "edit this page" links.
42+
editUrl:
43+
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
44+
},
45+
blog: {
46+
showReadingTime: true,
47+
feedOptions: {
48+
type: ['rss', 'atom'],
49+
xslt: true,
50+
},
51+
// Please change this to your repo.
52+
// Remove this to remove the "edit this page" links.
53+
editUrl:
54+
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
55+
// Useful options to enforce blogging best practices
56+
onInlineTags: 'warn',
57+
onInlineAuthors: 'warn',
58+
onUntruncatedBlogPosts: 'warn',
59+
},
60+
theme: {
61+
customCss: './src/css/custom.css',
62+
},
63+
} satisfies Preset.Options,
64+
],
65+
],
6666

67-
themeConfig: {
68-
// Replace with your project's social card
69-
image: 'img/docusaurus-social-card.jpg',
70-
navbar: {
71-
title: 'Manual Rede Mapas',
72-
logo: {
73-
alt: 'Logo Rede Mapas',
74-
src: 'img/logo.svg',
75-
},
76-
items: [
77-
{
78-
type: 'docSidebar',
79-
sidebarId: 'tutorialSidebar',
80-
position: 'left',
81-
label: 'Tutorial',
82-
},
83-
{to: '/blog', label: 'Blog', position: 'left'},
84-
{
85-
href: 'https://github.com/redemapas/mapas',
86-
label: 'GitHub',
87-
position: 'right',
88-
},
89-
],
90-
},
91-
footer: {
92-
style: 'dark',
93-
links: [
94-
{
95-
title: 'Docs',
96-
items: [
97-
{
98-
label: 'Tutorial',
99-
to: '/docs/intro',
100-
},
101-
],
102-
},
103-
// {
104-
// title: 'Community',
105-
// items: [
106-
// {
107-
// label: 'Stack Overflow',
108-
// href: 'https://stackoverflow.com/questions/tagged/docusaurus',
109-
// },
110-
// {
111-
// label: 'Discord',
112-
// href: 'https://discordapp.com/invite/docusaurus',
113-
// },
114-
// {
115-
// label: 'X',
116-
// href: 'https://x.com/docusaurus',
117-
// },
118-
// ],
119-
// },
120-
{
121-
title: 'More',
122-
items: [
123-
{
124-
label: 'Blog',
125-
to: '/blog',
126-
},
127-
// {
128-
// label: 'GitHub',
129-
// href: 'https://github.com/facebook/docusaurus',
130-
// },
131-
],
132-
},
133-
],
134-
copyright: `RedeMapas ${new Date().getFullYear()}.`,
135-
},
136-
prism: {
137-
theme: prismThemes.github,
138-
darkTheme: prismThemes.dracula,
139-
},
140-
} satisfies Preset.ThemeConfig,
67+
themeConfig: {
68+
// Replace with your project's social card
69+
image: 'img/docusaurus-social-card.jpg',
70+
navbar: {
71+
title: 'Manual Rede Mapas',
72+
logo: {
73+
alt: 'Logo Rede Mapas',
74+
src: 'img/logo.svg',
75+
},
76+
items: [
77+
{
78+
type: 'docSidebar',
79+
sidebarId: 'tutorialSidebar',
80+
position: 'left',
81+
label: 'Tutorial',
82+
},
83+
{ to: '/blog', label: 'Blog', position: 'left' },
84+
{
85+
href: 'https://github.com/redemapas/mapas',
86+
label: 'GitHub',
87+
position: 'right',
88+
},
89+
],
90+
},
91+
footer: {
92+
style: 'dark',
93+
links: [
94+
{
95+
title: 'Docs',
96+
items: [
97+
{
98+
label: 'Tutorial',
99+
to: '/docs/intro',
100+
},
101+
],
102+
},
103+
// {
104+
// title: 'Community',
105+
// items: [
106+
// {
107+
// label: 'Stack Overflow',
108+
// href: 'https://stackoverflow.com/questions/tagged/docusaurus',
109+
// },
110+
// {
111+
// label: 'Discord',
112+
// href: 'https://discordapp.com/invite/docusaurus',
113+
// },
114+
// {
115+
// label: 'X',
116+
// href: 'https://x.com/docusaurus',
117+
// },
118+
// ],
119+
// },
120+
{
121+
title: 'More',
122+
items: [
123+
{
124+
label: 'Blog',
125+
to: '/blog',
126+
},
127+
// {
128+
// label: 'GitHub',
129+
// href: 'https://github.com/facebook/docusaurus',
130+
// },
131+
],
132+
},
133+
],
134+
copyright: `RedeMapas ${new Date().getFullYear()}.`,
135+
},
136+
prism: {
137+
theme: prismThemes.github,
138+
darkTheme: prismThemes.dracula,
139+
},
140+
} satisfies Preset.ThemeConfig,
141141
};
142142

143143
export default config;

0 commit comments

Comments
 (0)