https://github.com/svoop/bridgetown-docset
Dash docset for Bridgetown
https://github.com/svoop/bridgetown-docset
bridgetown dash ruby
Last synced: 17 days ago
JSON representation
Dash docset for Bridgetown
- Host: GitHub
- URL: https://github.com/svoop/bridgetown-docset
- Owner: svoop
- License: mit
- Created: 2022-11-26T19:29:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-03T13:57:09.000Z (about 1 year ago)
- Last Synced: 2025-02-12T11:34:28.957Z (2 months ago)
- Topics: bridgetown, dash, ruby
- Language: Ruby
- Homepage:
- Size: 11.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Dash Docset for Bridgetown
## Download
No releases yet, there's still too much room for improvements. However, you can download the `bt.docset` artefact of the [latest successful workflow run](https://github.com/svoop/bridgetown-docset/actions).
## Development
Install [Ruby](https://www.ruby-lang.org), then...
```bash
# Install tools
brew install dashing
# Set tag
TAG=$(cat tag.txt)
# Checkout tag
git clone https://github.com/bridgetownrb/bridgetown.git source
cd source
git checkout tags/$TAG -b branch-$TAG
# Relax Ruby version
echo "ruby-3.3" >bridgetown-website/.ruby-version
# Direnv (if used)
echo "use ruby" >bridgetown-website/.envrc
# Build website
cd bridgetown-website
bundle install
yarn install
bridgetown deploy
# Transform content
cd output
../../../transform.rb
# Build docset
cp ../../../dashing.json ../../../icon.png .
dashing build bridgetown
# Install docset
open bt.docset
```
## Action
The workflow reads the tag to build the docset for from `tag.txt`.