-
-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #37 from Kitware/documentation-site
Documentation site
- Loading branch information
Showing
113 changed files
with
2,446 additions
and
3,011 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 |
|---|---|---|
|
|
@@ -3,5 +3,3 @@ | |
| .npmrc | ||
| npm-debug.log | ||
| node_modules | ||
| documentation/www | ||
| documentation/_tmp | ||
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
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,7 @@ | ||
| .DS_Store | ||
| .idea/ | ||
| node_modules/ | ||
| *.log | ||
| db.json | ||
| public/ | ||
| .deploy*/ |
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,37 @@ | ||
| # ParaViewWeb developer Website | ||
|
|
||
| The website for ParaViewWeb can be found at [kitware/paraviewweb](https://github.com/kitware/paraviewweb) repository. | ||
|
|
||
| ## Getting started | ||
|
|
||
| Install dependencies: | ||
|
|
||
| ``` bash | ||
| $ git clone https://github.com/kitware/paravieweb.git | ||
| $ cd documentation/www | ||
| ``` | ||
|
|
||
| Generate: | ||
|
|
||
| ``` bash | ||
| $ npm run build | ||
| ``` | ||
|
|
||
| Run server: | ||
|
|
||
| ``` bash | ||
| $ npm run server | ||
| ``` | ||
|
|
||
| ## Contributors | ||
|
|
||
| - English - [tommy351](https://github.com/tommy351) | ||
| - 正體中文 - [tommy351](https://github.com/tommy351) | ||
| - 简体中文 - [pinggod](https://github.com/pinggod), [Xuanwo](https://github.com/Xuanwo) | ||
|
|
||
| ## License | ||
|
|
||
| [CC BY 4.0](http://creativecommons.org/licenses/by/4.0/) | ||
|
|
||
| [tommy351]: https://github.com/tommy351 | ||
| [pinggod]: https://github.com/pinggod |
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,22 @@ | ||
| title: ParaViewWeb | ||
| description: "ParaViewWeb is a Web framework which allow to bring the power of ParaView and VTK into the Web." | ||
| subtitle: "Small framework for bringing scientific visualization to the Web" | ||
| author: Kitware Inc. | ||
| language: en | ||
| timezone: UTC | ||
| url: https://kitware.github.io/paraviewweb | ||
| root: /paraviewweb/ | ||
| permalink: news/:year/:month/:day/:title/ | ||
| archive_dir: news | ||
| code_dir: downloads/code | ||
| new_post_name: :year-:month-:day-:title.md # File name of new posts | ||
| post_asset_folder: true | ||
| highlight: | ||
| enable: true | ||
| line_number: false | ||
| per_page: 0 | ||
|
|
||
| theme: navy | ||
|
|
||
| google_analytics: | ||
| github: kitware/paraviewweb |
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,72 @@ | ||
| 'use strict'; | ||
|
|
||
| var gulp = require('gulp'); | ||
| var $ = require('gulp-load-plugins')(); | ||
| var cssnano = require('cssnano'); | ||
|
|
||
| var dirs = { | ||
| public: 'public', | ||
| screenshots: 'public/build/screenshots' | ||
| }; | ||
|
|
||
| gulp.task('useref', ['screenshot'], function(){ | ||
| var assets = $.useref.assets({ | ||
| searchPath: 'public' | ||
| }); | ||
|
|
||
| return gulp.src('public/**/*.html') | ||
| // .pipe(assets) | ||
| .pipe($.uniqueFiles()) | ||
| .pipe($.if('*.css', $.postcss([ | ||
| cssnano() | ||
| ]))) | ||
| .pipe($.if('*.js', $.uglify())) | ||
| .pipe($.rev()) | ||
| .pipe(assets.restore()) | ||
| // .pipe($.useref()) | ||
| // .pipe($.revReplace({ | ||
| // prefix: '/' | ||
| // })) | ||
| .pipe(gulp.dest('public')); | ||
| }); | ||
|
|
||
| gulp.task('screenshot:rev', function(){ | ||
| return gulp.src('public/applications/screenshots/*.png') | ||
| .pipe($.rev()) | ||
| .pipe(gulp.dest(dirs.screenshots)) | ||
| .pipe($.rev.manifest()) | ||
| .pipe(gulp.dest(dirs.screenshots)); | ||
| }); | ||
|
|
||
| gulp.task('screenshot:resize', ['screenshot:rev'], function(){ | ||
| return gulp.src(dirs.screenshots + '/*.png') | ||
| .pipe($.responsive({ | ||
| '*.png': [ | ||
| { | ||
| width: 400, | ||
| progressive: true | ||
| }, | ||
| { | ||
| progressive: true, | ||
| rename: { | ||
| suffix: '@2x' | ||
| } | ||
| } | ||
| ] | ||
| })) | ||
| .pipe(gulp.dest(dirs.screenshots)); | ||
| }); | ||
|
|
||
| gulp.task('screenshot:revreplace', ['screenshot:rev'], function(){ | ||
| return gulp.src([dirs.screenshots + '/rev-manifest.json', 'public/applications/index.html']) | ||
| .pipe($.revCollector({ | ||
| replaceReved: true, | ||
| dirReplacements: { | ||
| '/applications/screenshots': '/build/screenshots' | ||
| } | ||
| })) | ||
| .pipe(gulp.dest('public/applications')); | ||
| }); | ||
|
|
||
| gulp.task('screenshot', ['screenshot:rev', 'screenshot:resize', 'screenshot:revreplace']); | ||
| gulp.task('default', ['useref', 'screenshot']); |
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,41 @@ | ||
| { | ||
| "name": "paraviewweb-site", | ||
| "version": "0.0.0", | ||
| "private": true, | ||
| "hexo": { | ||
| "version": "3.2.0" | ||
| }, | ||
| "scripts": { | ||
| "build": "hexo generate && gulp", | ||
| "server": "hexo server", | ||
| "doc": "npm run build && npm run server" | ||
| }, | ||
| "dependencies": { | ||
| "cheerio": "^0.20.0", | ||
| "hexo": "^3.2.0", | ||
| "hexo-deployer-git": "^0.1.0", | ||
| "hexo-generator-archive": "^0.1.4", | ||
| "hexo-generator-feed": "^1.1.0", | ||
| "hexo-generator-sitemap": "^1.1.2", | ||
| "hexo-renderer-jade": "^0.3.0", | ||
| "hexo-renderer-marked": "^0.2.10", | ||
| "hexo-renderer-stylus": "^0.3.1", | ||
| "hexo-server": "^0.2.0", | ||
| "lodash": "^4.5.1", | ||
| "lunr": "^0.6.0" | ||
| }, | ||
| "devDependencies": { | ||
| "cssnano": "^3.5.2", | ||
| "gulp": "^3.9.1", | ||
| "gulp-if": "^2.0.0", | ||
| "gulp-load-plugins": "^1.2.0", | ||
| "gulp-postcss": "^6.1.0", | ||
| "gulp-responsive": "^2.1.0", | ||
| "gulp-rev": "^6.0.1", | ||
| "gulp-rev-collector": "^1.0.2", | ||
| "gulp-rev-replace": "^0.4.3", | ||
| "gulp-uglify": "^1.5.3", | ||
| "gulp-unique-files": "^0.1.2", | ||
| "gulp-useref": "^2.1.0" | ||
| } | ||
| } |
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,2 @@ | ||
| title: {{ title }} | ||
| --- |
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,2 @@ | ||
| title: {{ title }} | ||
| --- |
Oops, something went wrong.