Plume/documentation
6
2
Fork 11
Code Issues 5 Pull requests 3 Releases Wiki Activity
The documentation for Plume. https://docs.joinplu.me/
304 commits 3 branches 0 tags 3.5 MiB
HTML 33.9%
SCSS 29.5%
Ruby 28%
JavaScript 6.5%
Shell 2.1%
Find a file
KitaitiMakoto 9460231982 Fix #77 Add language switcher (again) (#113) 
Update README

Fix a typo

Prepend bundle exec to middleman command

Use link_to_lang helper

Use relative path for links

Append solidus to links to directory index

Update Bundler

Install Webrick

Add Webrick to dependencies

Remove Crowdin related code from template

Co-authored-by: Kitaiti Makoto <KitaitiMakoto@gmail.com>
Reviewed-on: #113
2020-12-27 15:51:03 +00:00
data Add language switcher 2020-12-20 15:12:19 +09:00
source Fix #77 Add language switcher (again) (#113) 2020-12-27 15:51:03 +00:00
.gitignore Ignore added build directories 2020-12-05 03:19:05 +09:00
config.rb Fix #77 Add language switcher (again) (#113) 2020-12-27 15:51:03 +00:00
crowdin.yml Reset build tasks 2020-12-20 14:02:06 +09:00
Gemfile Fix #77 Add language switcher (again) (#113) 2020-12-27 15:51:03 +00:00
Gemfile.lock Fix #77 Add language switcher (again) (#113) 2020-12-27 15:51:03 +00:00
LICENSE Create LICENSE 2019-04-20 18:54:56 +01:00
Rakefile Fix #77 Add language switcher (again) (#113) 2020-12-27 15:51:03 +00:00
README.md Fix #77 Add language switcher (again) (#113) 2020-12-27 15:51:03 +00:00

README.md

docs

The documentation for Plume, available at docs.joinplu.me.

Uses middleman.

Prerequisites

  • Ruby
  • Crowdin CLI v3 if you build translations
  • Netlify CLI if you deploy

Setting up

Install RubyGems including middleman:

bundle config set --local path vendor/bundle
bundle install

Editing documentation

Run

bundle exec middleman

, visit http://localhost:4567/, and then you can see documentation site.

Edit files under source directory and reload your browser, then you see updated content. But this site doesn't include translations. If you want to include translated pages, see next section.

After editing, create a pull request.

Building site with translation integration

If you want to build site with translations, you need set up Crowdin CLI.

Run

bundle exec rake build_site

and then the site with translations is built under build directory. You can see the site using one-liner server such as

ruby -run -e httpd build

or web server such as Caddy.

Updating translation strings

When you add and/or modify strings from current sources, you may want to translate them. To do so, updated contents need to be uploaded to Crowdin. Run

bundle exec rake crowdin:upload

then you can translate strings at Crowdin.

Building translation site

When you build site for https://translate.docs.joinplu.me/, run

bundle exec rake build_trans

then the site is built under translate directory.

Deploying site

You need Netlify CLI if you deploy site.

Run

bundle exec rake deploy

then you can see updated site at https://docs.joinplu.me/.

Deploying translation site

Run

bundle exec rake deploy_trans

and then you can see updated translation site at https://translate.docs.joinplu.me/.