Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs switches to vuepress!! #471

Merged
merged 2 commits into from
Oct 9, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
module.exports = {
title: "just ___",
description: "The task library that just works",
base: "/just/",
themeConfig: {
nav: [
{ text: "Home", link: "/" },
{ text: "Guide", link: "/guide/" },
{ text: "Github", link: "https://github.com/microsoft/just" },
],
sidebar: [
{
title: 'Home', // required
path: '/', // optional, link of the title, which should be an absolute path and must exist
},
{
title: 'Tasks',
path: '/tasks',
collapsable: false,
sidebarDepth: 1,
children: [ '/tasks/composition', '/tasks/logging', '/tasks/args', '/tasks/condition', '/tasks/thunk' ]
},
{
title: 'Scripts',
path: '/scripts',
collapsable: false,
sidebarDepth: 1,
children: [ '/scripts/typescript', '/scripts/webpack', '/scripts/lint', '/scripts/jest' ]
}
]
},

plugins: [
[
"mermaidjs",
{
gantt: {
barHeight: 20,
fontSize: 12,
useWidth: 960,
},
},
],
],
};
1 change: 1 addition & 0 deletions docs/.vuepress/public/.nojekyll
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Keep
2 changes: 2 additions & 0 deletions docs/.vuepress/styles/palette.styl
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
$contentWidth ?= 960px
$accentColor = #000080
23 changes: 23 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
home: true
# heroImage: /hero.png
heroText: The task library that just works
tagline: A sensible set of task to build, test, and lint your frontend projects
actionText: Get Started →
actionLink: /tasks/
features:
- title: Flexible
details: 'Unlike create-react-app, just gives sensible defaults but does not hide config files'
- title: Task orchestration
details: Like gulp, just provides parallel() and series() to fine tune task runs
- title: No waiting for latest devDependencies
details: just-scripts knows how to run tools, but it does not prescribe versions of the dependencies - you upgrade at your own timing!
- title: TypeScript suport
details: just-scripts configurations are TypeScript-enabled, so you don't have to have a separate build step to use your build tools
- title: Lightweight task orchestration
details: just-task is a lightweight task orchestrator that has no streaming file system abstraction
- title: Battle tested
details: just is built upon just the right abstraction from the gulp ecosystem, which is used by many repos

footer: MIT Licensed | Copyright © 2020-present Microsoft
---
File renamed without changes
File renamed without changes
1 change: 0 additions & 1 deletion docs/css/main.css

This file was deleted.

115 changes: 0 additions & 115 deletions docs/css/prism.css

This file was deleted.

83 changes: 0 additions & 83 deletions docs/docs/args.html

This file was deleted.

Loading