1
0
mirror of https://github.com/thangisme/notes.git synced 2024-10-31 17:57:42 -04:00

Merge pull request #19 from pmarsceill/task-lists

Task lists
This commit is contained in:
Patrick Marsceill 2018-11-16 11:54:02 -05:00 committed by GitHub
commit 0a5edea9d8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
17 changed files with 182 additions and 15 deletions

View File

@ -21,6 +21,9 @@ baseurl: "/just-the-docs/" # the subpath of your site, e.g. /blog
permalink: pretty
exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"]
# Enable or disable the site search
search_enabled: true
# Aux links for the upper right navigation
aux_links:
"Just the Docs on GitHub":

View File

@ -4,7 +4,9 @@
<title>{{ page.title }} - {{ site.title }}</title>
<link rel="stylesheet" href="{{ "/assets/css/just-the-docs.css" | absolute_url }}">
{% if site.search_enabled != nil %}
<script type="text/javascript" src="{{ "/assets/js/vendor/lunr.min.js" | absolute_url }}"></script>
{% endif %}
<script type="text/javascript" src="{{ "/assets/js/just-the-docs.js" | absolute_url }}"></script>
<meta name="viewport" content="width=device-width, initial-scale=1">

View File

@ -16,7 +16,8 @@
</div>
<div class="main-content-wrap">
<div class="page-header">
<div class="main-content pb-0">
<div class="main-content">
{% if site.search_enabled != nil %}
<div class="search js-search">
<div class="search-input-wrap">
<input type="text" class="js-search-input search-input" placeholder="Search {{ site.title }}" aria-label="Search {{ site.title }}" autocomplete="off">
@ -24,8 +25,9 @@
</div>
<div class="js-search-results search-results-wrap"></div>
</div>
{% endif %}
{% if site.aux_links != nil %}
<ul class="list-style-none text-small mt-md-2 pb-4 pb-md-0 js-aux-nav aux-nav">
<ul class="list-style-none text-small mt-md-1 mb-md-1 pb-4 pb-md-0 js-aux-nav aux-nav">
{% for link in site.aux_links %}
<li class="d-inline-block my-0{% unless forloop.last %} mr-2{% endunless %}"><a href="{{ link.last }}">{{ link.first }}</a></li>
{% endfor %}

View File

@ -56,6 +56,23 @@
}
}
.task-list {
padding-left: 0;
}
.task-list-item {
display: flex;
align-items: center;
&::before {
content: "";
}
}
.task-list-item-checkbox {
margin-right: 0.6em;
}
hr + * {
margin-top: 0;
}

View File

@ -79,8 +79,6 @@
@include mq(md) {
background-color: $white;
border-bottom: $border $border-color;
}
.main-content {
@ -88,8 +86,11 @@
@include mq(md) {
display: flex;
justify-content: space-between;
justify-content: flex-end;
height: 60px;
padding-top: $sp-4;
padding-bottom: $sp-4;
border-bottom: $border $border-color;
}
}
}

View File

@ -14,7 +14,7 @@
z-index: 101;
height: 60px;
padding-top: $sp-4;
box-shadow: inset 0 -1px 0 $border-color;
border-bottom: $border $border-color;
}
}

View File

@ -17,7 +17,7 @@
display: block;
padding-top: $sp-1;
padding-right: 0;
padding-bottom: $sp-4;
padding-bottom: 0;
padding-left: 0;
margin-bottom: 0;
background-color: transparent;

View File

@ -155,7 +155,9 @@ function initSearch() {
function ready(){
toggleNav();
if (typeof lunr !== 'undefined') {
initSearch();
}
}
// in case the document is already rendered

25
docs/configuration.md Normal file
View File

@ -0,0 +1,25 @@
---
layout: default
title: Configuration
nav_order: 2
---
# Configuration
Just the Docs has some specific configuration parameters that can be definied in your Jekyll site's `config.yml` file.
## Search enabled
```yml
# Enable or disable the site search
search_enabled: true
```
## Aux links
```yml
# Aux links for the upper right navigation
aux_links:
"Just the Docs on GitHub":
- "//github.com/pmarsceill/just-the-docs"
```

View File

@ -1,7 +1,7 @@
---
layout: default
title: Customization
nav_order: 5
nav_order: 6
---
# Customization

View File

@ -94,6 +94,12 @@ end
- level 2 item
- level 1 item
### And a task list
- [ ] Hello, this is a TODO item
- [ ] Hello, this is another TODO item
- [x] Goodbye, this item is done
### Small image
![](https://assets-cdn.github.com/images/icons/emoji/octocat.png)

View File

@ -1,7 +1,7 @@
---
layout: default
title: Navigation Structure
nav_order: 4
nav_order: 5
---
# Navigation Structure

View File

@ -1,7 +1,7 @@
---
layout: default
title: Search
nav_order: 6
nav_order: 7
---
# Search
@ -12,7 +12,9 @@ Just the docs uses [lunr.js](http://lunrjs.com) to add a client-side search inte
- Page content
- Page URL
## Setup search
## Set up search
### 1. Generate search index
Before you can use search, you must initialize the feature by running this
rake command that comes with the `just-the-docs`
@ -41,3 +43,12 @@ your search index. Alternatively, you can create the file manually in the
```
_Note: If you don't run this rake command or create this file manually, search will not work (or it will use the search index data from this docs site, not your site's content)._
### 2. Enable search in configuration
In your site's `_config.yml` enable search:
```yml
# Enable or disable the site search
search_enabled: true
```

View File

@ -2,7 +2,7 @@
layout: default
title: Code
parent: UI Components
nav_order: 5
nav_order: 6
---
# Code

View File

@ -0,0 +1,98 @@
---
layout: default
title: Lists
parent: UI Components
nav_order: 5
---
# Lists
{:.no_toc}
## Table of contents
{: .no_toc .text-delta }
1. TOC
{:toc}
---
Most lists can be rendered with pure markdown...
## Unordered list
<div class="code-example" markdown="1">
- Item 1
- Item 2
- Item 3
_or_
* Item 1
* Item 2
* Item 3
</div>
```markdown
- Item 1
- Item 2
- Item 3
_or_
* Item 1
* Item 2
* Item 3
```
## Ordered list
<div class="code-example" markdown="1">
1. Item 1
1. Item 2
1. Item 3
</div>
```markdown
1. Item 1
1. Item 2
1. Item 3
```
## Task list
<div class="code-example" markdown="1">
- [ ] hello, this is a todo item
- [ ] hello, this is another todo item
- [x] goodbye, this item is done
</div>
```markdown
- [ ] hello, this is a todo item
- [ ] hello, this is another todo item
- [x] goodbye, this item is done
```
## Definition list
Definition lists require HTML syntax and aren't supported with the GitHub flavored markdown compiler.
<div class="code-example" markdown="1">
<dl>
<dt>Name</dt>
<dd>Godzilla</dd>
<dt>Born</dt>
<dd>1952</dd>
<dt>Birthplace</dt>
<dd>Japan</dd>
<dt>Color</dt>
<dd>Green</dd>
</dl>
</div>
```html
<dl>
<dt>Name</dt>
<dd>Godzilla</dd>
<dt>Born</dt>
<dd>1952</dd>
<dt>Birthplace</dt>
<dd>Japan</dd>
<dt>Color</dt>
<dd>Green</dd>
</dl>
```

View File

@ -1,7 +1,7 @@
---
layout: default
title: UI Components
nav_order: 2
nav_order: 3
has_children: true
parent: UI Components
permalink: /ui-components

View File

@ -1,7 +1,7 @@
---
layout: default
title: Utilities
nav_order: 3
nav_order: 4
parent: Utilities
has_children: true
permalink: /utilities