layout | permalink |
---|---|
page |
/ |
Dogwood is the theme for the Jekyll static site generator powering openstreetmap.us. While the content for the OpenStreetMap US website is kept internal to the organization, we've decided to open source the site's theme for the benefit of the community.
Dogwood pushes the envelope of what's possible with static site generators. It supports complex sites with thousands of interconnected, customizable pages, each with their own requirements. For example, you can make a page for a person that links to and from posts they've written, event they've spoken at, and projects they're a part of.
Dogwood is under active development and is not currently versioned. Breaking changes may occur without notice, so we recommend targeting a specific commit of the project of simply forking it.
The Dogwood theme is named for Virginia's state flower, since the OpenStreetMap US website redesign was announced onstage at State of the Map US 2023 in Richmond, Virginia.
Dogwood is not distributed as a Ruby gem at this time. However, can still use Dogwood as a theme for your Jekyll site.
Open your terminal and cd
into the repo's directory. Add Dogwood as a submodule:
$ git submodule add https://github.com/osmus/dogwood.git
This will clone the theme repo into a dogwood
folder and also add a .gitmodules file:
[submodule "dogwood"]
path = dogwood
url = https://github.com/osmus/dogwood.git
Next, add these lines to your Jekyll site's Gemfile
:
# theme
gem "osmus-dogwood", path: "dogwood"
# theme plugins
gem "absolute-urls", path: "./dogwood/_plugins/absolute-urls"
gem "post-aliases", path: "./dogwood/_plugins/post-aliases"
gem "unwrap-img", path: "./dogwood/_plugins/unwrap-img"
Add this line to your Jekyll site's _config.yml
:
theme: osmus-dogwood
And then execute:
$ bundle install
If you're already running your dev server you'll need to manually restart it for the config changes to take effect
Participation is subject to the OpenStreetMap US Code of Conduct. Please take a moment to review the CoC prior to contributing, and remember to be nice :)
You can open an issue in this repository if you have a question, comment, or idea. Please search existing issues first in case someone else had the same thought. Pull request are public, but we recommend opening or commenting on an issue before writing any code so that we can make sure your work is aligned with the goals of the project.
- Clone the repository
- Open your terminal and
cd
into the repo's directory - Run
bundle install
to install the Ruby gems - Run
bundle exec jekyll serve
(or simplyjekyll serve
) to start the development server - Visit http://localhost:4000 in your browser
The theme is available as open source under the terms of the MIT License.
- Dogwood was originally designed and developed by Quincy Morgan under contract to OpenStreetMap US
- Most icons by FontAwesome
- Thank you to the Jekyll team and to everyone who believes in open software and knowledge