Skip to content

Commit

Permalink
New website (alfio-event#822)
Browse files Browse the repository at this point in the history
* first version of the website, WIP

* move existing tutorials + organize images

* remove docsy license and add a mention to the README
  • Loading branch information
cbellone authored and syjer committed Oct 31, 2019
1 parent 9636fe0 commit 4a38730
Show file tree
Hide file tree
Showing 59 changed files with 4,198 additions and 25 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "website/themes/docsy"]
path = website/themes/docsy
url = https://github.com/google/docsy.git
6 changes: 6 additions & 0 deletions website/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

public/
resources/
node_modules/
tech-doc-hugo

67 changes: 67 additions & 0 deletions website/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Alf.io website

This website uses

- [Hugo](https://gohugo.io) for generating the html
- [Docsy](https://github.com/google/docsy) theme for Hugo, released under [Apache v2](https://github.com/google/docsy/blob/master/LICENSE).

## Getting started

**Please follow Docsy's [Getting Started](https://www.docsy.dev/docs/getting-started/) guide in order to prepare your environment.**



Since Docsy is included as a submodule, you have to make sure to clone also submodules. (don't forget to use `--recurse-submodules` or you won't pull down some of the code you need to generate a working site).

The `hugo server` command builds and serves the site. If you just want to build the site, run `hugo` instead.

```bash
git clone --recurse-submodules --depth 1 https://github.com/alfio-event/alf.io.git
cd alf.io/website
hugo server
```

The Docsy theme is included as a Git submodule:

```bash
▶ git submodule
a053131a4ebf6a59e4e8834a42368e248d98c01d themes/docsy (heads/master)
```

If you want to do SCSS edits and want to publish these, you need to install `PostCSS` (not needed for `hugo server`):

```bash
npm install
```

<!--### Cloning the Example from the Theme Project
```bash
git clone --recurse-submodules --depth 1 https://github.com/docsy.git
cd tech-doc-hugo-theme/exampleSite
HUGO_THEMESDIR="../.." hugo server
```
Note that the Hugo Theme Site requires the `exampleSite` to live in a subfolder of the theme itself. To avoid recursive duplication, the example site is added as a Git subtree:
```bash
git subtree add --prefix exampleSite https://github.com/google/docsy.git master --squash
```
To pull in changes, see `pull-deps.sh` script in the theme.-->

## Running the website locally

Once you've cloned the site repo, move to the `website` folder and run:

```
hugo server
```



-------------------------------

This website is is a modified version of the great [Docsy website example](https://github.com/google/docsy-example)
59 changes: 59 additions & 0 deletions website/assets/icons/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions website/assets/scss/_variables_project.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/*
Add styles or override variables from the theme here.
*/
$google_font_name: "Source Sans Pro";
$google_font_family: "Source+Sans+Pro";
$web-font-path: "https://fonts.googleapis.com/css?family=#{$google_font_family}&display=swap";
$td-enable-google-fonts: true;

// Theme colors

$primary: #ff8812;

$secondary: #6c757d;
$success: #28a745;
$info: #17a2b8;
$warning: #ffc107;
$danger: #dc3545;
$light: #f8f9fa;
$dark: #343a40;
$primary-light: lighten($primary, 75%);
149 changes: 149 additions & 0 deletions website/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
baseURL = "/"
title = "Alf.io"

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 = "Alf.io"
description = "the open source ticket reservation system"
languageName ="English"
# Weight used for sorting.
weight = 1

time_format_default = "02.01.2006"
time_format_blog = "02.01.2006"


# Everything below this are Site Params

[params]
copyright = "The Alf.io contributors"
#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"

# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo = "https://github.com/alfio-event/alf.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/alfio-event/alf.io"

# Specify a value here if your content directory is not in your repo's root directory
github_subdir = "website"

# Google Custom Search Engine ID. Remove or comment out to disable search.
gcs_engine_id = "013857515530291939659:1fytqjdhtfm"

# Enable Algolia DocSearch
algolia_docsearch = 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 = true

# 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 = false
# 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>.'

[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://groups.google.com/d/forum/alfio"
icon = "fa fa-envelope"
desc = "Discussion and help from your fellow users"
[[params.links.user]]
name ="Twitter"
url = "https://twitter.com/alfio_event"
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"

Loading

0 comments on commit 4a38730

Please sign in to comment.