https://github.com/codegouvfr/nextra-theme-dsfr
DSFR theme for Nextra
https://github.com/codegouvfr/nextra-theme-dsfr
Last synced: 12 months ago
JSON representation
DSFR theme for Nextra
- Host: GitHub
- URL: https://github.com/codegouvfr/nextra-theme-dsfr
- Owner: codegouvfr
- License: mit
- Created: 2023-06-28T11:32:53.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-01T09:57:20.000Z (over 2 years ago)
- Last Synced: 2025-04-24T05:03:55.200Z (about 1 year ago)
- Language: TypeScript
- Size: 765 KB
- Stars: 3
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
DSFR theme for Nextra
Demo repo
-
Show me what it looks like
# Install / Import
```bash
$ yarn add @codegouvfr/nextra-theme-dsfr @codegouvfr/react-dsfr @mui/material @emotion/styled @emotion/react @emotion/server
```
# Contributing
## Starting the demo app in dev mode
```bash
cd ~/github
git clone https://github.com/garronej/nextra-theme-dsfr
cd nextra-theme-dsfr
yarn dev
```
Then in another terminal.
```bash
cd ~/github/nextra-dsfr-demo
yarn start
```
Now you can do changes both in `~/github/nextra-theme-dsfr` and `~/github/nextra-dsfr/demo`.
You will see the change live in the app.
> NOTE: Each time you changes any dependencies you must restart `yarn dev` and `yarn start`.
## Testing your changes in an external app
You have made some changes to the code and you want to test them
in your app before submitting a pull request?
```bash
cd ~/github
git clone https://github.com/garronej/nextra-dsfr-demo
cd nextra-dsfr-demo
yarn
cd ~/github
git clone https://github.com/codegouvfr/nextra-theme-dsfr
cd nextra-theme-dsfr
yarn
yarn build
yarn link-in-app nextra-dsfr-demo
npx tsc -w
# Open another terminal
cd ~/github/nextra-dsfr-demo
rm -rf node_modules/.cache
yarn dev # Or whatever my-app is using for starting the project
```
You don't have to use `~/github` as a reference path. Just make sure `nextra-dsfr-demo` and `nextra-theme-dsfr`
are in the same directory.
## Releasing
For releasing a new version on GitHub and NPM you don't need to create a tag.
Just update the `package.json` version number and push.
For publishing a release candidate update your `package.json` with `1.3.4-rc.0` (`.1`, `.2`, ...).
It also works if you do it from a branch that has an open PR on `main`.
> Make sure you have defined the `NPM_TOKEN` repository secret or NPM publishing will fail.
## Maintainers
- [Joseph Garrone](https://github.com/garronej)
- [Dylan DECRULLE](https://github.com/ddecrulle) - Insee
- [Dimitri POSTOLOV](https://github.com/B2o5T) - Main [Nextra](https://nextra.site) maintainer