generated from finos-labs/project-blueprint
-
Notifications
You must be signed in to change notification settings - Fork 64
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add docusaurus #138
Merged
Merged
Add docusaurus #138
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
1b3b303
add docusaurus
TheJuanAndOnly99 2d5d63a
remove accidental paste of website folder
TheJuanAndOnly99 6ca23ff
rebuild lock file
TheJuanAndOnly99 5ceb7fe
ignore broken links
TheJuanAndOnly99 b60e4fb
ignore broken links
TheJuanAndOnly99 8d2eda6
ignore broken links
TheJuanAndOnly99 ed1c8a4
Upgraded docusaurus, added missing ajv, updated homepage content.
1eaae47
Update netlify.toml
TheJuanAndOnly99 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
id: home | ||
title: "Homepage" | ||
--- | ||
|
||
Welcome to TraderX! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
id: roadmap | ||
title: "TraderX Roadmap" | ||
--- | ||
|
||
This is the TraderX Roadmap: | ||
1. ... | ||
2. ... | ||
3. ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
id: team | ||
title: "TraderX Team" | ||
--- | ||
|
||
This is the TraderX team: | ||
1. ... | ||
2. ... | ||
3. ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
[build] | ||
ignore = "git diff --quiet $CACHED_COMMIT_REF $COMMIT_REF . ../{docs,website}/" | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
legacy-peer-deps=true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
This website was created with [Docusaurus v2](https://v2.docusaurus.io/). | ||
|
||
In order to start working with Docusaurus, please read the [Getting Started guide](https://docusaurus.io/docs/configuration) and browse through the following folders and files: | ||
- `website` - contains the Node/React code to build the website | ||
- `website/docusaurus.config.js` - contains the Docusaurus configuration; you'll need to edit this file. | ||
- `website/static` - contains images, PDF and other static assets used in the website; if you add a `file.pdf` in this folder, it will be served as `https://<your_host>/file.pdf`. | ||
- `docs` - contains the `.md` and `.mdx` files that are served as `https://<your_host>/<file_id>` ; the `file_id` is defined at the top of the file. | ||
|
||
## Local run | ||
|
||
Running Docusaurus locally is very simple, just follow these steps: | ||
- Make sure `node` version is 14 or higher, using `node -v` ; you can use [nvm](https://github.com/nvm-sh/nvm) to install different node versions in your system. | ||
- `cd website ; npm install ; npm run start` | ||
|
||
The command should open your browser and point to `http://localhost:3000`. | ||
|
||
## Deployment | ||
|
||
[Netlify] (https://www.netlify.com/) is the default way to serve FINOS websites publicly. Find docs [here] (https://docs.netlify.com/configure-builds/get-started/). | ||
|
||
You can configure Netlify using your own GitHub account, pointing to a personal repository (or fork); when adding a new site, please use the following configuration: | ||
- Woeking directory: `website` | ||
- Build command: `yarn build` | ||
- Build directory: `website/build` | ||
|
||
If you want to serve your website through `https://<project_name>.finos.org`, please email [[email protected]](mailto:[email protected]). To check a preview, visit https://project-blueprint.finos.org . |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,118 @@ | ||
// Docs at https://docusaurus.io/docs | ||
|
||
const projectName = 'TraderX' | ||
const projectSlug = 'traderX' | ||
const copyrightOwner = 'FINOS - The Fintech Open Source Foundation' | ||
|
||
module.exports = { | ||
onBrokenLinks: 'ignore', | ||
title: `${projectName}`, | ||
tagline: `${projectName}`, | ||
url: 'https://finos.org', | ||
baseUrl: '/', | ||
trailingSlash: false, | ||
favicon: 'img/favicon/favicon-traderX.ico', | ||
projectName: `${projectName}`, | ||
organizationName: 'FINOS', | ||
customFields: { | ||
repoUrl: `https://github.com/finos/${projectSlug}`, | ||
}, | ||
scripts: ['https://buttons.github.io/buttons.js'], | ||
stylesheets: ['https://fonts.googleapis.com/css?family=Overpass:400,400i,700'], | ||
themeConfig: { | ||
navbar: { | ||
title: `TraderX`, | ||
logo: { | ||
alt: 'TraderX Logo', | ||
src: 'img/favicon/favicon-traderX.ico', | ||
}, | ||
items: [ | ||
{to: 'docs/home', label: 'Docs', position: 'right'}, | ||
{to: 'docs/roadmap', label: 'Roadmap', position: 'right'}, | ||
{to: 'docs/team', label: 'Team', position: 'right'}, | ||
{ | ||
href: 'https://github.com/finos/', | ||
label: 'GitHub', | ||
position: 'right', | ||
} | ||
], | ||
}, | ||
footer: { | ||
copyright: `Copyright © ${new Date().getFullYear()} TraderX - ${copyrightOwner}`, | ||
logo: { | ||
alt: 'FINOS Logo', | ||
src: 'img/favicon/favicon-finos.ico', | ||
href: 'https://finos.org' | ||
}, | ||
links: [ | ||
{ | ||
title: 'Docs', | ||
items: [ | ||
{ | ||
label: 'Getting Started', | ||
to: 'docs/home', | ||
}, | ||
{ | ||
label: 'Roadmap', | ||
to: 'docs/roadmap', | ||
}, | ||
{ | ||
label: 'Team', | ||
to: 'docs/team', | ||
} | ||
] | ||
}, | ||
{ | ||
title: 'FINOS', | ||
items: [ | ||
{ | ||
label: 'FINOS Website', | ||
to: 'https://www.finos.org/', | ||
}, | ||
{ | ||
label: 'Community Handbook', | ||
to: 'https://community.finos.org/', | ||
}, | ||
{ | ||
label: 'FINOS Projects', | ||
to: 'https://landscape.finos.org', | ||
} | ||
] | ||
}, | ||
{ | ||
title: 'About FINOS', | ||
items: [ | ||
{ | ||
label: 'FINOS Projects on GitHub', | ||
to: 'https://github.com/finos', | ||
}, | ||
{ | ||
label: 'Engage the FINOS Community', | ||
to: 'https://www.finos.org/engage-with-our-community', | ||
}, | ||
{ | ||
label: 'FINOS News and Events', | ||
to: 'https://www.finos.org/news-and-events', | ||
} | ||
] | ||
}, | ||
] | ||
}, | ||
}, | ||
presets: [ | ||
[ | ||
'@docusaurus/preset-classic', | ||
{ | ||
docs: { | ||
path: '../docs', | ||
editUrl: | ||
'https://github.com/finos/traderX/edit/main/website/', | ||
sidebarPath: require.resolve('./sidebars.js') | ||
}, | ||
theme: { | ||
customCss: require.resolve('./src/css/custom.css'), | ||
} | ||
} | ||
] | ||
] | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
{ | ||
"scripts": { | ||
"docusaurus": "docusaurus", | ||
"deploy": "docusaurus deploy", | ||
"serve": "docusaurus serve", | ||
"clear": "docusaurus clear", | ||
"start": "docusaurus start", | ||
"swizzle": "docusaurus swizzle", | ||
"build": "docusaurus build", | ||
"publish-gh-pages": "docusaurus deploy" | ||
}, | ||
"dependencies": { | ||
"@docusaurus/core": "^3.2.0", | ||
"@docusaurus/preset-classic": "^3.2.0", | ||
"ajv": "^8.12.0", | ||
"classnames": "^2.5.1", | ||
"clsx": "^2.0.0", | ||
"prism-react-renderer": "^2.3.0", | ||
"react": "^18.0.0", | ||
"react-dom": "^18.0.0" | ||
}, | ||
"devDependencies": { | ||
"eslint": "^8.0.0", | ||
"eslint-plugin-react": "^7.23.2" | ||
}, | ||
"browserslist": { | ||
"production": [ | ||
">0.5%", | ||
"not dead", | ||
"not op_mini all" | ||
], | ||
"development": [ | ||
"last 1 chrome version", | ||
"last 1 firefox version", | ||
"last 1 safari version" | ||
] | ||
}, | ||
"engines": { | ||
"node": ">=18.0" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
module.exports = { | ||
mainSidebar: { | ||
'Main Menu': ["home", "team", "roadmap"] | ||
}, | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
.features { | ||
display: flex; | ||
align-items: center; | ||
padding: 2rem 0; | ||
width: 100%; | ||
} | ||
|
||
.featureSvg { | ||
height: 200px; | ||
width: 200px; | ||
} | ||
|
||
.divider { | ||
border: 100000px solid #000 !important; | ||
} | ||
|
||
.furtherReading { | ||
display: flex; | ||
flex-direction: column; | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@TheJuanAndOnly99 , we tried quite a few combination of this - and ended up just by using /bin/false . If you figure out a working setup (that works for the draft pages too and for normal, etc), I am super interested.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @psmulovics not sure I understand what you mean by draft vs normal pages. The objective here is to only run Netlify on PRs that contain changes to the docs and website folders.