Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wgao19/docusaurus-template-no-style
🦖 Opinionated minimum style template for Docusaurus 2
https://github.com/wgao19/docusaurus-template-no-style
Last synced: 3 months ago
JSON representation
🦖 Opinionated minimum style template for Docusaurus 2
- Host: GitHub
- URL: https://github.com/wgao19/docusaurus-template-no-style
- Owner: wgao19
- Created: 2019-07-27T17:41:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T05:31:57.000Z (almost 2 years ago)
- Last Synced: 2024-07-18T08:45:28.751Z (4 months ago)
- Language: JavaScript
- Homepage: https://docusaurus-template-no-style.netlify.com/
- Size: 4.19 MB
- Stars: 22
- Watchers: 2
- Forks: 0
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Docusaurus Template No Style
🦖 Opinionated minimum style template for Docusaurus 2
The motivation of creating this template:
- to learn how Docusaurus 2 works
- to create a template with nearly no styling so that I can add my own styling without much hassle later on
## About this template
### 💚 [>> DEMO >>](https://docusaurus-template-no-style.netlify.com/) 💚
This template uses [@wgao19/docusaurus-theme-no-style](https://github.com/wgao19/docusaurus-theme-no-style) nearly directly.
With two customizations for demonstration purposes:
- Adds a custom CSS to use a customized font [IBM Plex Sans](https://fonts.google.com/specimen/IBM+Plex+Sans)
- Swizzles the `Footer` component (see below to see how)
Check out [Docusaurus 2](http://docusaurus-2.netlify.com/) docs for more information on developing with D2.
## Using this template
```shell
$ npx @docusaurus/init@next init [your-project-name] https://github.com/wgao19/docusaurus-template-no-style.git
$ cd your-project-name
$ yarn start
```
## Overwriting styles for this template
Depending on how fine-grained you wish to overwrite the styles, you have a few options:
### Using custom CSS
The [theme](https://github.com/wgao19/docusaurus-theme-no-style) we use for this template allows an option field `customCss` that allows us to import our custom CSS that will be imported right before React renders our initial UI.
To specify your custom CSS:
```js
// docusaurus.config.js
module.exports = {
themes: [
[
"@wgao19/docusaurus-theme-no-style",
{
// path relative to your project root
customCss: require.resolve("./src/css/custom.css")
}
]
]
};
```
### Modifying basic (layout) styling
To modify the styling without changing the DOM structure of individual components, you may swizzle the `Layout` component and update the CSS there:
```shell
$ yarn swizzle @wgao19/docusaurus-theme-no-style Layout
```
This will copy the `Layout` component to your site's `src` directory. Restart your dev server, and then the site will be using the component in your code.
Most of the styles provided in this theme is inside the `Layout` component.
### Modifying component styling
If you need to modify the DOM structure and / or styling for individual component, swizzle the corresponding component with the same command.
For list of components to swizzle, refer to the [theme](https://github.com/wgao19/docusaurus-theme-no-style/tree/master/packages/docusaurus-theme-no-style/src/theme).
## Credits
### Logo credit
Icons made by [Darius Dan](https://www.flaticon.com/authors/darius-dan) from [flaticon](https://www.flaticon.com/).
### Created by
This template alongside its [theme](https://github.com/wgao19/docusaurus-theme-no-style) is created by [Wei](https://twitter.com/wgao19) who is a maintainer of Docusaurus together with [Yangshun](https://twitterhe.com/yangshunz) and [Endiliey](https://twitter.com/endiliey).
Yangshun and Endiliey offered tremendous insights in the creation of this template and theme.