search.gov
How to add a new post
- Clone the
master
branch. - Create a new file in the drafts directory
using the following naming convention:
YYYY-MM-DD-post-filename-title.md
- Add the YAML block to the top of the file. You can use the following sample file as a starting point.
- Add the content of your new post below the YAML block. Feel free to use HTML, Markdown or Liquid Extension.
- Add, commit and push your new post back to the repository.
- After roughly 3 minutes, visit
{{ site.baseurl }}/drafts/post-filename-title.html
to preview your post. If you added a permalink config in your post, visit{{ site.baseurl }}/drafts/your-permalink.html
- When you're ready to publish your post, move the file from from drafts to the _posts directory.
How to set up your development environment
Open a Terminal window. Start homebrew.
$ brew update
$ brew doctor
We use bundler to manage gems. cd
into the local repo. Install bundler and other required gems.
$ gem install bundler
$ bundle install
Running the site locally
To build the pages with Jekyll:
- open a new tab in terminal
- Navigate to the root directory of the project
- run:
bundle exec jekyll serve
- Go to http://localhost:4000. The site should have the expected content & formatting of the [Search.gov]({{ site.baseurl }}/) homepage.
To build the CSS styles:
- open a new tab in terminal
- Navigate to the root directory of the project
- run:
gulp
- Go to http://localhost:4000. The site should have the expected content & formatting of the [Search.gov]({{ site.baseurl }}/) homepage.
Template Images
To reference images in the the site templates, use the path to the image within the /assets/img
folder.
{{ "/assets/img/site/searchdotgovlogo.png" | prepend: site.baseurl }}
-
For more information about Jekyll, visit the wiki pages.
-
If you don't already have it, you'll need the Ruby version specified in
.ruby-version
. RVM is recommended to install Ruby on your development environment. Verify that your path points to the correct version of Ruby:$ ruby -v ruby 2.5.5p157 (2019-03-15 revision 67260) [x86_64-darwin18]