mirror of
https://github.com/oceanprotocol/datascience.git
synced 2022-09-23 03:31:37 +02:00
docs & formatting
This commit is contained in:
parent
0430cfb6fc
commit
5ba805396f
20
README.md
20
README.md
@ -8,10 +8,9 @@
|
||||
[![Build Status](https://travis-ci.com/oceanprotocol/datascience.svg?token=3psqw6c8KMDqfdGQ2x6d&branch=master)](https://travis-ci.com/oceanprotocol/datascience)
|
||||
[![js oceanprotocol](https://img.shields.io/badge/js-oceanprotocol-7b1173.svg)](https://github.com/oceanprotocol/eslint-config-oceanprotocol)
|
||||
|
||||
|
||||
---
|
||||
|
||||
- [Link creation](#link-creation)
|
||||
- [Copy editing](#copy-editing)
|
||||
- [Editing workflow](#editing-workflow)
|
||||
- [Development](#development)
|
||||
- [Deployment](#deployment)
|
||||
@ -20,7 +19,7 @@
|
||||
|
||||
---
|
||||
|
||||
## Link creation
|
||||
## Copy editing
|
||||
|
||||
Create a new link by editing the [`content.yml`](content.yml) file. When editing on GitHub, click the pencil icon to start editing the file:
|
||||
|
||||
@ -29,13 +28,18 @@ Create a new link by editing the [`content.yml`](content.yml) file. When editing
|
||||
Only thing to remember is to keep the indentation as in this example:
|
||||
|
||||
```yaml
|
||||
- name: Dutchchain Hackathon 2018
|
||||
url: https://forms.google.com/fewfewhgvbzfbwbe
|
||||
|
||||
- name: my other link
|
||||
url: https://hello.com/fdasfrebvfbvgt
|
||||
links:
|
||||
- name: JupyterHub Notebook
|
||||
url: https://longurl.com
|
||||
- name: Another JupyterHub Notebook
|
||||
url: https://longurl.com
|
||||
```
|
||||
|
||||
This example would result in:
|
||||
|
||||
<img width="700" alt="screen shot 2018-12-04 at 14 58 25" src="https://user-images.githubusercontent.com/90316/49446699-152a7980-f7d5-11e8-8945-959f2e05e90b.png">
|
||||
|
||||
|
||||
### Editing workflow
|
||||
|
||||
The basic workflow goes like this:
|
||||
|
@ -4,6 +4,8 @@ intro: Tools for data scientists to interact with the Ocean Protocol network.
|
||||
links:
|
||||
- name: JupyterHub Notebook
|
||||
url: https://longurl.com
|
||||
- name: Another JupyterHub Notebook
|
||||
url: https://longurl.com
|
||||
|
||||
footer:
|
||||
- name: Homepage
|
||||
|
@ -63,10 +63,8 @@ export const fonts = () =>
|
||||
export const logos = () =>
|
||||
src([
|
||||
'node_modules/@oceanprotocol/art/logo/**/*',
|
||||
'node_modules/@oceanprotocol/art/mantaray/**/*',
|
||||
]).pipe(
|
||||
dest(DIST + '/assets/img/')
|
||||
)
|
||||
'node_modules/@oceanprotocol/art/mantaray/**/*'
|
||||
]).pipe(dest(DIST + '/assets/img/'))
|
||||
|
||||
//
|
||||
// Copy Favicon
|
||||
@ -100,7 +98,7 @@ export const revReplace = () => {
|
||||
// Watch for file changes
|
||||
//
|
||||
export const watchSrc = () =>
|
||||
watch([SRC, 'links.yml']).on('all', series(build, browser.reload))
|
||||
watch([SRC, 'content.yml']).on('all', series(build, browser.reload))
|
||||
|
||||
//
|
||||
// Dev Server
|
||||
|
@ -6,7 +6,8 @@ body {
|
||||
}
|
||||
|
||||
main {
|
||||
background: $brand-black url('/assets/img/mantaray-back.svg') no-repeat center top;
|
||||
background: $brand-black url('/assets/img/mantaray-back.svg') no-repeat
|
||||
center top;
|
||||
background-size: cover;
|
||||
min-height: 100vh;
|
||||
display: flex;
|
||||
@ -66,7 +67,7 @@ img {
|
||||
white-space: nowrap;
|
||||
margin-bottom: $spacer;
|
||||
max-width: 20rem;
|
||||
background: rgba($brand-black, .8);
|
||||
background: rgba($brand-black, 0.8);
|
||||
}
|
||||
|
||||
footer {
|
||||
|
Loading…
Reference in New Issue
Block a user