Skip to content

Commit

Permalink
chore(website): use same toolchain with nodejs binding
Browse files Browse the repository at this point in the history
Signed-off-by: suyanhanx <suyanhanx@gmail.com>
  • Loading branch information
suyanhanx committed Mar 13, 2023
1 parent 182717b commit 95bf5f0
Show file tree
Hide file tree
Showing 6 changed files with 7,597 additions and 8,527 deletions.
5 changes: 0 additions & 5 deletions .typos.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,3 @@
"ba" = "ba"
# Showed up in examples.
"thw" = "thw"

[files]
extend-exclude = [
"website/pnpm-lock.yaml"
]
1 change: 0 additions & 1 deletion licenserc.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ excludes = [
"tests/data/**",
"bindings/nodejs/.npmignore",
"bindings/python/test_requirements.txt",
"website/pnpm-lock.yaml",

# Env example that doesn't need license.
".env.example",
Expand Down
6 changes: 3 additions & 3 deletions website/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
### Installation

```
$ pnpm i
$ yarn
```

### Local Development

```
$ pnpm start
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ pnpm build
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
32 changes: 10 additions & 22 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,23 +27,15 @@ const config = {
tagline: 'Open Data Access Layer: Access data freely, painlessly, and efficiently',
favicon: 'img/favicon.ico',

// Set the production url of your site here
url: 'https://opendal.apache.org',
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: '/',

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'Apache', // Usually your GitHub org/username.
projectName: 'OpenDal', // Usually your repo name.
organizationName: 'Apache',
projectName: 'OpenDal',

onBrokenLinks: 'warn',
onBrokenMarkdownLinks: 'warn',

// Even if you don't use internalization, you can use this field to set useful
// metadata like html lang. For example, if your site is Chinese, you may want
// to replace "en" with "zh-Hans".
i18n: {
defaultLocale: 'en',
locales: ['en'],
Expand All @@ -56,19 +48,15 @@ const config = {
({
docs: {
sidebarPath: require.resolve('./sidebars.js'),
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
'https://github.com/datafuselabs/opendal/website/',
showLastUpdateAuthor: true,
showLastUpdateTime: true
},
blog: {
showReadingTime: true,
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
'https://github.com/datafuselabs/opendal/website/',
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
Expand All @@ -86,8 +74,8 @@ const config = {
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
// Replace with your project's social card
// image: 'img/docusaurus-social-card.jpg',
// TODO social card image
// image: 'img/opendal-social-card.jpg',
colorMode: {
defaultMode: 'light',
disableSwitch: true
Expand All @@ -113,10 +101,10 @@ const config = {
label: 'RFCs',
to: 'https://opendal.databend.rs/opendal/docs/rfcs/index.html'
},
// {
// type: 'html',
// value: '<hr class="dropdown-separator">'
// },
{
type: 'html',
value: '<hr class="dropdown-separator">'
},
{
label: 'Node.js',
to: 'https://www.npmjs.com/package/opendal'
Expand Down
Loading

0 comments on commit 95bf5f0

Please sign in to comment.