osquery-1/docs/_posts/2017-08-20-welcome-to-osquery.md

1.3 KiB
Raw Blame History

title categories
Welcome to osquery! update

Welcome to the new osquery.io homepage. This is built using Jekyll and features a new news, community, and inline documentation set of pages.

Youll find this post in the /docs/_posts directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run bundle exec jekyll serve, which launches a web server and auto-regenerates your site when a file is updated.

To add new posts, simply add a file in the /docs/_posts directory that follows the convention YYYY-MM-DD-name-of-post.md and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.

Jekyll also offers powerful support for code snippets:

{% highlight ruby %} def print_hi(name) puts "Hi, #{name}" end print_hi('osquery users') #=> prints 'Hi, osquery users' to STDOUT. {% endhighlight %}

Check out the Jekyll docs for more info on how to get the most out of Jekyll. File all bugs/feature requests at Jekylls GitHub repo. If you have questions, you can ask them on Jekyll Talk.