- Notifications
You must be signed in to change notification settings - Fork0
Repository to store gunrock documents (slate).
License
NotificationsYou must be signed in to change notification settings
sgpyc/docs
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
Deploying Gunrock Slate Docs (http://gunrock.github.io/docs)
You're going to need:
- Linux or OS X — Windows may work, but is unsupported.
- Ruby, version 2.3.1 or newer
- Bundler — If Ruby is already installed, but the
bundle
command doesn't work, just rungem install bundler
in a terminal.
- Create a markdown page with the extension
.html.md
and add it to the source directory. - Slate markdowns use the following header for page settings like title, footer, etc.
---# title of the pagetitle: <Gunrock-Page-Title># add a language tab, doesn't work with full_length set to true# must be one of https://git.io/vQNgJlanguage_tabs: - shell - ruby - python - javascript# page footertoc_footers: - <a href='https://github.com/gunrock/gunrock'>Gunrock; GPU Graph Analytics</a> - Gunrock © 2018 The Regents of the University of California.# add markdown files in /source/includes directory to append the page with this headerincludes: - <filetoinclude> - <filetoinclude># include search bar in the left menu?search: true# full length page or two sections?full_length: true ---
- Note that vega graphs are just
<div><script> (json dump) </script></div>
.