https://github.com/opensumi/gatsby-theme

The Gatsby theme for OpenSumi documentation site.
https://github.com/opensumi/gatsby-theme

Last synced: 3 days ago
JSON representation

The Gatsby theme for OpenSumi documentation site.

• Host: GitHub
• URL: https://github.com/opensumi/gatsby-theme
• Owner: opensumi
• License: other
• Created: 2022-06-01T08:05:32.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-21T07:06:20.000Z (11 months ago)
• Last Synced: 2024-09-24T07:35:55.351Z (about 2 months ago)
• Language: TypeScript
• Size: 456 KB
• Stars: 5
• Watchers: 6
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
> This Theme is modified from [antvis/gatsby-theme-antv](https://github.com/antvis/gatsby-theme-antv), thanks for their contribute.





# Gatsby Theme for OpenSumi

✨ Polished Gatsby theme for documentation site.

[![](https://flat.badgen.net/npm/v/@opensumi/gatsby-theme?icon=npm)](https://www.npmjs.com/package/@opensumi/gatsby-theme)

[![NPM downloads](http://img.shields.io/npm/dm/@opensumi/gatsby-theme.svg?style=flat-square)](http://npmjs.com/@opensumi/gatsby-theme)

![CI status](https://github.com/opensumi/gatsby-theme/workflows/Node%20CI/badge.svg)

![prettier code style](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)



## Features

- 🔍 Docsearch v3, React 18, Gatsby 4 supported.

- 🎨 Prerendered static site

- 🌎 Internationalization support by i18next

- 📝 Markdown-based documentation and menus

- 🏗 Unified Theme and Layout

- 🎲 Easy customized header nav

- 🧩 Built-in home page components

## Develop

```bash

yarn

yarn start

```

Visit https://localhost:8000 to preview.

## Add Dependency

```bash

cd @opensumi/gatsby-theme

yarn add shallowequal

```

or

```bash

yarn workspace @opensumi/gatsby-theme add shallowequal

```

## Q&A

### How to customise layout footer?

```js

// gatsby-browser.js

exports.wrapPageElement = ({ element, props }) => {

  return React.cloneElement(element, {

    ...props,

    ...element.props,

    // https://github.com/react-component/footer#api

    footerProps: {

      bottom: 'xxx',

    },

  });

};

```

### How to embed other markdown document in a markdown document

```markdown

`markdown:docs/common/data-mapping.zh.md`

```

_docs/common/data-mapping.zh.md_ is the path relative to the current project. It supports multiple levels of nested.

## Related libraries

- [Gatsby](https://www.gatsbyjs.org/docs/)

- [Ant Design](https://github.com/ant-design/ant-design)

- [gatsby-transformer-remark](https://www.gatsbyjs.org/packages/gatsby-transformer-remark/)

- [gatsby-remark-prismjs](https://www.gatsbyjs.org/packages/gatsby-remark-prismjs/?=highlight#line-highlighting)

- [Jest](https://jestjs.io/)

- [Testing Library](https://testing-library.com/)

- [react-i18next](https://react.i18next.com/)

- [docsearch](https://docsearch.algolia.com/)