Configure gh-pages
This commit is contained in:
parent
38783de90c
commit
7cd89fee19
|
@ -26,15 +26,15 @@ gem 'ransack'
|
||||||
|
|
||||||
### Bleeding edge
|
### Bleeding edge
|
||||||
|
|
||||||
If you would like to use the latest updates not yet published to RubyGems, use the `master` branch:
|
If you would like to use the latest updates not yet published to RubyGems, use the `main` branch:
|
||||||
|
|
||||||
```jsx title='Gemfile'
|
```jsx title='Gemfile'
|
||||||
gem 'ransack', :github => 'activerecord-hackery/ransack', :branch => 'master'
|
gem 'ransack', :github => 'activerecord-hackery/ransack', :branch => 'main'
|
||||||
```
|
```
|
||||||
|
|
||||||
### Documentation
|
### Documentation
|
||||||
|
|
||||||
There is extensive documentation on Ransack, which is a [Docusaurus](https://docusaurus.io/) project and run as a GitHub Pages site.
|
There is [extensive documentation on Ransack](https://activerecord-hackery.github.io/ransack/), which is a [Docusaurus](https://docusaurus.io/) project and run as a GitHub Pages site.
|
||||||
|
|
||||||
## Issues tracker
|
## Issues tracker
|
||||||
|
|
||||||
|
|
|
@ -13,3 +13,19 @@ Make sure you have `npm` installed, then:
|
||||||
cd docs-website
|
cd docs-website
|
||||||
npm run start
|
npm run start
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Build
|
||||||
|
|
||||||
|
Build the assets before commiting changes.
|
||||||
|
|
||||||
|
```
|
||||||
|
cd docs-website
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
### Test locally
|
||||||
|
|
||||||
|
```
|
||||||
|
cd docs-website
|
||||||
|
npm run serve
|
||||||
|
```
|
||||||
|
|
|
@ -15,6 +15,7 @@ const config = {
|
||||||
favicon: 'img/favicon.ico',
|
favicon: 'img/favicon.ico',
|
||||||
organizationName: 'activerecord-hackery',
|
organizationName: 'activerecord-hackery',
|
||||||
projectName: 'ransack',
|
projectName: 'ransack',
|
||||||
|
trailingSlash: false,
|
||||||
|
|
||||||
presets: [
|
presets: [
|
||||||
[
|
[
|
||||||
|
@ -69,7 +70,7 @@ const config = {
|
||||||
items: [
|
items: [
|
||||||
{
|
{
|
||||||
label: 'Documentation',
|
label: 'Documentation',
|
||||||
to: '/docs/intro',
|
to: '/',
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
|
Loading…
Reference in New Issue