Skip to content

BiggerPockets/blueprint

Repository files navigation

blueprint

the BiggerPockets product & engineering blog

You can use the editor on GitHub to maintain and preview the content for your website in Markdown files.

Whenever you commit to this repository, GitHub Pages will run Jekyll to rebuild the pages in your site, from the content in your Markdown files.

To run the site locally

bundle install

bundle exec jekyll serve

Preview your local Jekyll site in your web browser at http://localhost:4000.

If you run Jekyll locally with the --drafts flag (e.g., jekyll serve --drafts), Jekyll will include any posts in the _drafts folder, just as if they were published post (but don't worry, only locally)

Contributing

  1. Create a branch
  2. Read _drafts/template.md
  3. Add the file _drafts/.md with the content you would like to submit.
    1. Include keywords you would like to target in the slug (a part of the file name) and title.
    2. Add the following meta-data to your post:
      1. title
      2. description
      3. tags
      4. image
        1. DO NOT include an image that we do not have the appropriate licence to
        2. https://www.pexels.com has many free to use images
        3. Commit a 670x446 sized image
      5. excerpt (optional)
    3. Commit reasonably sized images for anything embedded in your post.
  4. Open a PR then private message your manager.

Markdown

Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for

Syntax highlighted code block

# Header 1
## Header 2
### Header 3

- Bulleted
- List

1. Numbered
2. List

**Bold** and _Italic_ and `Code` text

[Link](url) and ![Image](src)

For more details see GitHub Flavored Markdown.

Jekyll Themes

Your Pages site will use the layout and styles from the Jekyll theme you have selected in your repository settings. The name of this theme is saved in the Jekyll _config.yml configuration file.

Support or Contact

Having trouble with Pages? Check out our documentation or contact support and we’ll help you sort it out.