The documentation for Plume. https://docs.joinplu.me/

選択できるのは25トピックまでです。トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。

ファイルへ移動

KitaitiMakoto bc2b9acfc4 Merge pull request 'Use locale instead of two_letters_code for translation' (#139 ) from locale into main Reviewed-on: #139		1年前
data	Use locale instead of two_letters_code for translation	1年前
source	Update schema to better reflect the current API	1年前
.gitignore	Ignore translate directory	3年前
Gemfile	Add a line wrapping css to not overflow on little screens, add mini_racer to dependencies to build	3年前
Gemfile.lock	Update gems	2年前
LICENSE	Create LICENSE	5年前
README.md	Fix #77 Add language switcher (again) (#113 )	3年前
Rakefile	Use locale instead of two_letters_code for translation	1年前
config.rb	Specify CSS class for syntax highlighting to avoide doubly add 'highlight'	3年前
crowdin.yml	Use locale instead of two_letters_code for translation	1年前

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/.