The documentation for Plume. https://docs.joinplu.me/
Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.
 
 
 
 
Kitaiti Makoto db3187ef88 Add document for env var RUST_LOG 1 vecka sedan
data Add language switcher 4 månader sedan
source Add document for env var RUST_LOG 1 vecka sedan
.gitignore Ignore translate directory 3 månader sedan
Gemfile Add a line wrapping css to not overflow on little screens, add mini_racer to dependencies to build 2 månader sedan
Gemfile.lock Update gems 1 vecka sedan
LICENSE Create LICENSE 2 år sedan
README.md Fix #77 Add language switcher (again) (#113) 3 månader sedan
Rakefile Add "all" task 2 månader sedan
config.rb Fix #77 Add language switcher (again) (#113) 3 månader sedan
crowdin.yml Reset build tasks 4 månader sedan

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