Events are managed through a Google Form and Sheet.
Blog posts are managed in the blog repo. Add a post following the instructions in the Readme.
During the regularly occurring site build process, any files in the app/assets/downloads/mapathon-materials/ folder will be zipped together and made available for download at http://www.missingmaps.org/assets/downloads/mapathon-materials.zip. Make sure the file at host.materials_list[0].asset in each app/_data/{{language_code}}.yml file exists in the downloads folder (e.g. mapathon-materials/english/How_to_Host_a_Mapathon_EN.pdf).
The site is configured to support 2-letter core language codes. So english is 'en' not 'en-US' and/or 'en-GB'. Using a longer code will not function.
There are four main steps in incorporating a language:
- tell app config the language exists
- add 2-letter language code to
authorized_localesarray in _config.yml
- add 2-letter language code to
- include locale file (to support date/time localization)
- several already in place (in _locales dir), otherwise get from here
- include _data/
2-letter code.yml to support site content translations- copy _data/en.yml, then update text values
- note that the url for the nav items can be updates for your language. this needs to align with the permalink in the page frontmatter (see item 4.2 below)
- create folder of page templates
- copy 'en' dir, rename copy as your 2-letter language code
- in frontmatter for all templates there within, you need to add the language code and pagename to the
permalink(i.e. /about/ becomes /fr/apropos/ for the french translation)
- create folder of blog posts
- copy the _posts/en dir, rename folder as your 2-letter language code
- in frontmatter for all templates there within, you need to change the
languageto the correct code and add the language code to thepermalink(i.e. /blog/:year/:month/:day/:title/ becomes /fr/blog/:year/:month/:day/:title/ for the french translation)
- (OPTIONAL) Add translations of pdf assets
- add documents to assets/downloads
- update _data/
2-letter code.yml host.materials_list.asset(s) with the filename you created
If the Jeykll build is failing when parsing one of the /app/_data/*.yml files, it can be useful to install and use yamllint. Running, for example, yamllint ./app/_data/fr.yml will output a large number of errors but you can find the critical ones base on the description, such as:
138:73 error syntax error: expected <block end>, but found '<scalar>' (syntax)
To set up the development environment for this website, you'll need to install the following on your system:
- Node and npm (version in
.nvmrcfile) - Ruby and Bundler, preferably through something like rvm (version in
.ruby-versionfile) - Gulp
$ gem install bundler -v 2.4.3
$ npm install -g gulp
$ npm install --global gulp-cli
After these basic requirements are met, run the following commands in the website's folder:
$ npm install
Will also run bundle install
If you get a jekyll-4.0.0 requires rubygems version >= 2.7.0, which is incompatible with the current version error then try running: gem update --system
$ gulp serve
Compiles the compass files, javascripts, and launches the server making the site available at http://localhost:3000/
The system will watch files and execute tasks whenever one of them changes.
The site will automatically refresh since it is bundled with livereload.
The _config-dev.yml file will be loaded alongside _config.yml.
Clean the compiled site. I.e. the _site folder
$ gulp clean
Compile the compass files, javascripts, and builds the jekyll site using _config-dev.yml.
Use this instead of gulp serve if you don't want to watch.
$ gulp
Compiles the site loading the _config-stage.yml alongside _config.yml. The javascript files will be minified.
$ gulp stage
Compiles the site loading the _config-prod.yml alongside _config.yml. The javascript files will be minified.
$ gulp prod
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent