| commit | a0e495a688e9598c9d84bb06a11250c119d889d8 | [log] [tgz] |
|---|---|---|
| author | Jason Campbell <jasoncampbell@google.com> | Wed Feb 10 13:08:33 2016 -0800 |
| committer | Jason Campbell <jasoncampbell@google.com> | Wed Feb 10 13:08:33 2016 -0800 |
| tree | f6e04713fc1913d216ba4c5adbb5e1bf89f3ba37 | |
| parent | 6874004f6b213ae8eae4fe836bced51445672490 [diff] |
website: removes JS related content The JavaScript libraries and infrastructure is not under active development and is not in an ideal state for consumption. This CL removes tutorial content and any wording that will lead someone to believe that the JS SDK is anything but experimental. Closes vanadium/issues#1123 Change-Id: If20acbf82263ac5cfd4187736f719cd93cf0d336
This repository contains the source code for generating the static assets for the Vanadium website.
browser - Client-side JS that executes when users visit the websitebuild - Output location for make buildcontent - Markdown content; gets converted to HTML by haikuhelpers.js - JS used by haiku when rendering Markdown filesnode_modules - Disposable directory created by npm installpackage.json - Tells npm install what to installpublic - Static assets, copied directly into the build directorystylesheets - LESS stylesheets, compiled into CSS for the websitetemplates - Mustache templates used by haiku for layouts and partialstools - Tools involved in generating the site's static assetsInstall Vanadium per the installation instructions on the website. Also, install the Node.js profile using jiri v23-profile install nodejs.
You can make and view changes locally by running a development server:
make serve
This command will print out a URL to visit in your browser. It will take a few minutes to run the first time around, but subsequent invocations will be fast.
By default, the running server will not reflect subsequent changes to the website content, since it's just serving the assets in the build directory. Running make build will cause the server to see the new content. Better yet, use the following command to automatically rebuild the assets whenever something changes:
make watch
This command requires the entr program, which can be installed on Debian/Ubuntu using apt-get install entr, and on OS X using brew install entr.
Add or modify Markdown-formatted files in the content directory.
The haiku tool provides some extra flexibility on top of standard Markdown by processing Mustache template variables. For example:
= yaml =
title: My Creative Title
author: Alice
= yaml =
# {{ page.title }}
Author: {{ page.author }}
A common editing workflow is to run make watch, edit Markdown files in a text editor, and refresh the browser to see changes. If you prefer a WYSIWYG editing experience, there are a number of options, e.g.:
For new content, it's common to do initial drafting and editing in Google Docs, and to switch to Markdown at publication time.
The make build task generates public/css/bundle.css and public/js/bundle.js from the files in stylesheets and browser respectively. To modify the website CSS or JS, edit those files, then rebuild the site (or use make watch to have your changes trigger rebuild).
The make deploy task deploys the website to GitHub Pages. Be sure to run this task from a clean master branch, and to run jiri update immediately before deploying to ensure that you aren‘t missing any upstream changes. We’re working on setting up additional checks to avoid these pitfalls, along with an automatic deployment process.