-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add hugo files & minimal site content
- set repo url to github.com/tetrabiodistributed/tetrabiodistributed.github.io - set local server to localhost:1313
- Loading branch information
1 parent
dc12ad5
commit bec81f8
Showing
33 changed files
with
4,024 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Project Tetra - Project Repository | ||
This repository contains the content and source code for generating the Project Tetra site. | ||
For more information about Project Tetra, please visit https://tetrabiodistributed.github.io/docs/ | ||
|
||
This Project is hosted at https://tetrabiodistributed.github.io | ||
|
||
## Prerequisites | ||
|
||
The following are basic prerequisites for previewing the Project Tetra site on your local machine: | ||
|
||
- [Install Hugo](https://gohugo.io/getting-started/installing/) for your specific platform. | ||
If you install from the [release page](https://github.com/gohugoio/hugo/releases), | ||
make sure you download the `_extended` version which supports SCSS. | ||
|
||
## Cloning the Project Tetra Project | ||
|
||
The following will clone the project repository onto your local machine. | ||
This will allow you to edit and preview changes to the project site | ||
(don't forget to use `--recurse-submodules` or you won't pull down some of the code you need to generate a working site). | ||
|
||
```bash | ||
git clone --recurse-submodules --depth 1 https://github.com/tetrabiodistributed/tetrabiodistributed.github.io.git | ||
cd project-tetra | ||
``` | ||
|
||
## Running the website locally | ||
|
||
Once you've cloned the project repo, from the `project-tetra` root directory, run: | ||
|
||
```bash | ||
hugo server | ||
``` | ||
|
||
The `hugo server` command builds and serves the site. | ||
If you just want to build the site, run `hugo` instead. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
/* | ||
Add styles or override variables from the theme here. | ||
*/ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,179 @@ | ||
baseURL = "https://tetrabiodistributed.github.io" | ||
title = "Project Tetra" | ||
canonifyURLs = false | ||
|
||
enableRobotsTXT = true | ||
|
||
# Hugo allows theme composition (and inheritance). The precedence is from left to right. | ||
theme = ["docsy"] | ||
|
||
# Will give values to .Lastmod etc. | ||
enableGitInfo = true | ||
|
||
# Language settings | ||
contentDir = "content/en" | ||
defaultContentLanguage = "en" | ||
defaultContentLanguageInSubdir = false | ||
# Useful when translating. | ||
enableMissingTranslationPlaceholders = true | ||
|
||
disableKinds = ["taxonomy", "taxonomyTerm"] | ||
|
||
# Highlighting config | ||
pygmentsCodeFences = true | ||
pygmentsUseClasses = false | ||
# Use the new Chroma Go highlighter in Hugo. | ||
pygmentsUseClassic = false | ||
#pygmentsOptions = "linenos=table" | ||
# See https://help.farbox.com/pygments.html | ||
pygmentsStyle = "tango" | ||
|
||
# Configure how URLs look like per section. | ||
[permalinks] | ||
blog = "/:section/:year/:month/:day/:slug/" | ||
|
||
## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday | ||
[blackfriday] | ||
plainIDAnchors = true | ||
hrefTargetBlank = true | ||
angledQuotes = false | ||
latexDashes = true | ||
|
||
# Image processing configuration. | ||
[imaging] | ||
resampleFilter = "CatmullRom" | ||
quality = 75 | ||
anchor = "smart" | ||
|
||
[services] | ||
[services.googleAnalytics] | ||
# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback]. | ||
id = "UA-00000000-0" | ||
|
||
# Language configuration | ||
|
||
[languages] | ||
[languages.en] | ||
title = "Project Tetra" | ||
description = "An open-source specification ventilator splitter for combating COVID-19" | ||
languageName ="English" | ||
# Weight used for sorting. | ||
weight = 1 | ||
[languages.es] | ||
title = "Project Tetra" | ||
description = "Un divisor de ventilador de especificación de código abierto para combatir COVID-19" | ||
languageName ="Spanish" | ||
contentDir = "content/es" | ||
|
||
[markup] | ||
[markup.goldmark] | ||
[markup.goldmark.renderer] | ||
unsafe = true | ||
|
||
# Everything below this are Site Params | ||
|
||
[params] | ||
copyright = "The Docsy Authors" | ||
privacy_policy = "https://policies.google.com/privacy" | ||
|
||
# First one is picked as the Twitter card image if not set on page. | ||
# images = ["images/project-illustration.png"] | ||
|
||
# Menu title if your navbar has a versions selector to access old versions of your site. | ||
# This menu appears only if you have at least one [params.versions] set. | ||
version_menu = "Releases" | ||
|
||
# Flag used in the "version-banner" partial to decide whether to display a | ||
# banner on every page indicating that this is an archived version of the docs. | ||
# Set this flag to "true" if you want to display the banner. | ||
archived_version = false | ||
|
||
# The version number for the version of the docs represented in this doc set. | ||
# Used in the "version-banner" partial to display a version number for the | ||
# current doc set. | ||
version = "0.0" | ||
|
||
# A link to latest version of the docs. Used in the "version-banner" partial to | ||
# point people to the main doc site. | ||
url_latest_version = "https://example.com" | ||
|
||
# Repository configuration (URLs for in-page links to opening issues and suggesting changes) | ||
github_repo = "https://github.com/tetrabiodistributed/tetrabiodistributed.github.io" | ||
# An optional link to a related project repo. For example, the sibling repository where your product code lives. | ||
github_project_repo = "https://github.com/google/docsy" | ||
|
||
# Specify a value here if your content directory is not in your repo's root directory | ||
# github_subdir = "" | ||
|
||
# Google Custom Search Engine ID. Remove or comment out to disable search. | ||
gcs_engine_id = "011737558837375720776:fsdu1nryfng" | ||
|
||
# Enable Algolia DocSearch | ||
algolia_docsearch = false | ||
|
||
# Enable Lunr.js offline search | ||
offlineSearch = false | ||
|
||
# User interface configuration | ||
[params.ui] | ||
# Enable to show the side bar menu in its compact state. | ||
sidebar_menu_compact = false | ||
# Set to true to disable breadcrumb navigation. | ||
breadcrumb_disable = false | ||
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled) | ||
sidebar_search_disable = false | ||
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar | ||
navbar_logo = true | ||
# Set to true to disable the About link in the site footer | ||
footer_about_disable = false | ||
|
||
# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events. | ||
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set. | ||
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page, | ||
# add "hide_feedback: true" to the page's front matter. | ||
[params.ui.feedback] | ||
enable = true | ||
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful). | ||
yes = 'Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.' | ||
no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.' | ||
|
||
# Adds a reading time to the top of each doc. | ||
# If you want this feature, but occasionally need to remove the Reading time from a single page, | ||
# add "hide_readingtime: true" to the page's front matter | ||
[params.ui.readingtime] | ||
enable = false | ||
|
||
[params.links] | ||
# End user relevant links. These will show up on left side of footer and in the community page if you have one. | ||
[[params.links.user]] | ||
name = "User mailing list" | ||
url = "https://example.org/mail" | ||
icon = "fa fa-envelope" | ||
desc = "Discussion and help from your fellow users" | ||
[[params.links.user]] | ||
name ="Twitter" | ||
url = "https://example.org/twitter" | ||
icon = "fab fa-twitter" | ||
desc = "Follow us on Twitter to get the latest news!" | ||
[[params.links.user]] | ||
name = "Stack Overflow" | ||
url = "https://example.org/stack" | ||
icon = "fab fa-stack-overflow" | ||
desc = "Practical questions and curated answers" | ||
# Developer relevant links. These will show up on right side of footer and in the community page if you have one. | ||
[[params.links.developer]] | ||
name = "GitHub" | ||
url = "https://github.com/google/docsy" | ||
icon = "fab fa-github" | ||
desc = "Development takes place here!" | ||
[[params.links.developer]] | ||
name = "Slack" | ||
url = "https://example.org/slack" | ||
icon = "fab fa-slack" | ||
desc = "Chat with other project developers" | ||
[[params.links.developer]] | ||
name = "Developer mailing list" | ||
url = "https://example.org/mail" | ||
icon = "fa fa-envelope" | ||
desc = "Discuss development issues around the project" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
+++ | ||
title = "Project Tetra" | ||
linkTitle = "Project Tetra" | ||
|
||
+++ | ||
|
||
{{< blocks/cover title="Welcome to Project Tetra: An open-source specification ventilator splitter for combating COVID-19" image_anchor="top" height="full" color="orange" >}} | ||
<div class="mx-auto"> | ||
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}"> | ||
Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i> | ||
</a> | ||
{{< blocks/link-down color="info" >}} | ||
</div> | ||
{{< /blocks/cover >}} | ||
|
||
|
||
{{% blocks/lead color="primary" %}} | ||
Current medical standard operating procedure requires that patients who become severely ill with COVID-19 be treated using external ventilation. | ||
As the virus spreads, projections suggest that there are not enough ventilators to meet the expected numbers of patients throughout the world. | ||
Project Tetra seeks to create a ventilator splitter so that hospitals inundated with covid-19 patients can effectively increase the number of already available ventilators by up to a factor of 4. | ||
|
||
The project aims to produce two versions of the device: | ||
|
||
1. a design that has been approved by the FDA under the Emergency Use Authorization guidance, and | ||
2. an open-source design intended to be made with locally sourced materials. | ||
|
||
{{% /blocks/lead %}} | ||
|
||
{{< blocks/section color="dark" >}} | ||
|
||
{{% blocks/feature icon=None %}} | ||
{{% /blocks/feature %}} | ||
|
||
{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="./docs/how-to-guides/contribution-guidelines/" %}} | ||
|
||
We do a [Pull Request](https://github.com/tetrabiodistributed/tetrabiodistributed.github.io/pulls) contributions workflow on **GitHub**. New users are always welcome! | ||
|
||
{{% /blocks/feature %}} | ||
|
||
{{< /blocks/section >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
title: About Project Tetra | ||
linkTitle: About | ||
menu: | ||
main: | ||
weight: 10 | ||
|
||
--- | ||
|
||
|
||
{{< blocks/cover title="About Project Tetra" image_anchor="bottom" height="min" >}} | ||
|
||
<p class="lead mt-5">A sample site using the Docsy Hugo theme. | ||
</p> | ||
|
||
{{< /blocks/cover >}} | ||
|
||
{{% blocks/lead %}} | ||
Project Tetra is a sample site using the <a href="https://github.com/google/docsy">Docsy</a> Hugo theme that shows what it can do and provides you with a template site structure. It’s designed for you to clone and edit as much as you like. See the different sections of the documentation and site for more ideas. | ||
{{% /blocks/lead %}} | ||
|
||
|
||
{{< blocks/section >}} | ||
<div class="col-12"> | ||
<h1 class="text-center">This is another section</h1> | ||
</div> | ||
|
||
{{< /blocks/section >}} | ||
|
||
|
||
|
||
{{< blocks/section >}} | ||
|
||
<div class="col-12"> | ||
<h1 class="text-center">This is another section</h1> | ||
</div> | ||
|
||
{{< /blocks/section >}} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: "Docsy Blog" | ||
linkTitle: "Blog" | ||
menu: | ||
main: | ||
weight: 30 | ||
--- | ||
|
||
|
||
This is the **blog** section. It has two categories: News and Releases. | ||
|
||
Files in these directories will be listed in reverse chronological order. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
|
||
--- | ||
title: "News About Docsy" | ||
linkTitle: "News" | ||
weight: 20 | ||
--- | ||
|
||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
date: 2018-10-06 | ||
title: "Easy documentation with Docsy" | ||
linkTitle: "Announcing Docsy" | ||
description: "The Docsy Hugo theme lets project maintainers and contributors focus on content, not on reinventing a website infrastructure from scratch" | ||
author: Riona MacNamara ([@rionam](https://twitter.com/bepsays)) | ||
resources: | ||
- src: "**.{png,jpg}" | ||
title: "Image #:counter" | ||
params: | ||
byline: "Photo: Riona MacNamara / CC-BY-CA" | ||
--- | ||
|
||
**This is a typical blog post that includes images.** | ||
|
||
The front matter specifies the date of the blog post, its title, a short description that will be displayed on the blog landing page, and its author. | ||
|
||
## Including images | ||
|
||
Here's an image (`featured-sunset-get.png`) that includes a byline and a caption. | ||
|
||
{{< imgproc sunset Fill "600x300" >}} | ||
Fetch and scale an image in the upcoming Hugo 0.43. | ||
{{< /imgproc >}} | ||
|
||
The front matter of this post specifies properties to be assigned to all image resources: | ||
|
||
``` | ||
resources: | ||
- src: "**.{png,jpg}" | ||
title: "Image #:counter" | ||
params: | ||
byline: "Photo: Riona MacNamara / CC-BY-CA" | ||
``` | ||
|
||
To include the image in a page, specify its details like this: | ||
|
||
``` | ||
{{< imgproc sunset Fill "600x300" >}} | ||
Fetch and scale an image in the upcoming Hugo 0.43. | ||
{{< /imgproc >}} | ||
``` | ||
|
||
The image will be rendered at the size and byline specified in the front matter. | ||
|
||
|
Oops, something went wrong.