Skip to content

Commit

Permalink
feat(tooling): remove go (#1210)
Browse files Browse the repository at this point in the history
  • Loading branch information
hugomrdias authored Oct 13, 2020
1 parent 1be7e48 commit 12718a8
Show file tree
Hide file tree
Showing 217 changed files with 5,881 additions and 379 deletions.
15 changes: 3 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,26 +22,25 @@ This is the [Filecoin Specification](https://github.com/filecoin-project/specs),
- [`listing`](#listing)
- [`mermaid`](#mermaid)
- [`hint`](#hint)
- [`katex`](#katex)
- [Math mode](#math-mode)
- [Wrap `def`, `gdef`, etc.](#wrap-def-gdef-etc)
- [Wrap inline math text with code blocks](#wrap-inline-math-text-with-code-blocks)
- [Wrap math blocks with code fences](#wrap-math-blocks-with-code-fences)
- [Front-matter](#front-matter)
- [External modules](#external-modules)
- [Solving Common problems](#solving-common-problems)
- [References](#references)

## Install

To build the spec website you need

- [`node` & `npm`](https://nodejs.org/en/download)
- [`go`](https://golang.org/doc/install)

On macOS you can get go from Homebrew
On macOS you can get node from Homebrew

```bash
brew install go
brew install node
```

Clone the repo, and use `npm install` to fetch the dependencies
Expand Down Expand Up @@ -380,14 +379,6 @@ or to a specific version with
hugo mod get github.com/filecoin-project/specs-actors@v0.7.2
```

## Solving Common problems

**Problem** - Site fails to build with an error that states it failed to download modules on macos

Error: failed to download modules: go command failed ...

**Solution** - run `npm run clean` - the cache dir hugo uses can get corrupted, and this resets it. See [#1048](https://github.com/filecoin-project/specs/issues/1048)

## References

- [hugo theme book](https://themes.gohugo.io//theme/hugo-book/docs/shortcodes/columns/)
Expand Down
72 changes: 51 additions & 21 deletions assets/_colors.scss
Original file line number Diff line number Diff line change
@@ -1,24 +1,54 @@
// Colors

.text-missing {
color: var(--cl-red);
}
.text-incorrect {
color: var(--cl-orange);
}
.text-wip {
color: var(--cl-yellow);
}
.text-reliable {
color: var(--cl-green);
}
.text-stable {
color: var(--cl-blue);
}
.text-transparent {
color: transparent;
}
.text-black {
color: black !important;
}

.text-missing {color: $red;}
.text-incorrect {color: $orange;}
.text-wip {color: $yellow;}
.text-reliable {color: $green;}
.text-stable {color: $blue;}
.text-transparent { color: transparent;}
.text-black { color: black !important;}

.bg-na { background-color: #6c8293;}
.bg-missing { background-color: $red; }
.bg-incorrect {background-color: $orange;}
.bg-wip {background-color: $yellow;}
.bg-done {background-color: $green; }
.bg-reliable {background-color: $green; }
.bg-stable { background-color: $blue;
a {
color: black;
}
}
.bg-transparent { background-color: transparent;}
.bg-black { background-color: black;}
.bg-na {
background-color: var(--cl-gray);
}
.bg-missing {
background-color: var(--cl-red);
}
.bg-incorrect {
background-color: var(--cl-orange);
}
.bg-wip {
background-color: var(--cl-yellow);
}
.bg-done {
background-color: var(--cl-green);
}
.bg-reliable {
background-color: var(--cl-green);
}
.bg-stable {
background-color: var(--cl-blue);
a {
color: black;
}
}
.bg-transparent {
background-color: transparent;
}
.bg-black {
background-color: black;
}
69 changes: 26 additions & 43 deletions assets/_custom.scss
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@

@import "plugins/numbered";
@import "plugins/scrollbars";
// @import "plugins/toggles";
@import "plugins/lightbox";
@import "plugins/bagdes";
@import "plugins/meter";
@import "plugins/toc";
@import "table-sort";
@import "plugins/table-sort";
@import "colors";
@import "dashboard";
@import "katex";
Expand All @@ -25,22 +24,26 @@ input.toggle {
visibility: hidden;
}


.markdown {
h1, h2, h3, h4, h5, h6 {
h1,
h2,
h3,
h4,
h5,
h6 {
a {
color: inherit;
text-decoration: none;
&:visited {
color:inherit;
color: inherit;
}
&:hover {
text-decoration: none;
&::after {
font-size: 70%;
padding-left:0.3em;
color: $color-link;
content: " #"
padding-left: 0.3em;
color: var(--color-link);
content: " #";
}
}
}
Expand All @@ -51,24 +54,23 @@ input.toggle {
color: inherit;
text-decoration: none;
&:visited {
color:inherit;
color: inherit;
}
&:hover {
text-decoration: none;
&::after {
font-size: 90%;
padding-left:0.3em;
color: $color-link;
content: " #"
padding-left: 0.3em;
color: var(--color-link);
content: " #";
}
}
}


// SVG Diagrams
.diagrams-container {
margin: 20px 0px;
border: 1px solid $gray-200;
border: 1px solid var(--gray-200);
border-radius: $border-radius;
}
.diagrams {
Expand Down Expand Up @@ -97,34 +99,16 @@ input.toggle {
font-weight: 500;
.diagrams-link {
text-decoration: none !important;
float:right;
float: right;
font-weight: 400;
}
}

// search
#book-search-results {
width: 100%;
padding: 1px .5rem;
border: 0;
border-radius: .25rem;
background: $book-search-results-bg;
margin-top: 3px;
}

#book-search-results:empty {
display: none;
}

#book-search-input {
outline: none;
}

.label {
font-size: 10px;
font-weight: 700;
display: block;
color:$gray-600;
color: var(--gray-600);
}

// Tweaks
Expand Down Expand Up @@ -163,7 +147,7 @@ blockquote {
height: 40px;
width: auto;
vertical-align: middle;
margin-inline-end: .5rem;
margin-inline-end: 0.5rem;
}

.book-header label {
Expand All @@ -173,7 +157,6 @@ blockquote {
align-items: center;
}


.book-menu {
position: fixed;
z-index: 3;
Expand All @@ -195,16 +178,16 @@ blockquote {
.book-menu {
transform: translateX(-20rem);
}
#menu-control:checked~main .book-page {
#menu-control:checked ~ main .book-page {
opacity: initial;
}

#menu-control:checked~.book-menu {
#menu-control:checked ~ .book-menu {
transform: translateX(0);
box-shadow: 0 0 $padding-8 rgba(0, 0, 0, 0.1);
}

#menu-control:checked~.book-menu-overlay {
#menu-control:checked ~ .book-menu-overlay {
display: block;
position: fixed;
z-index: 2;
Expand All @@ -216,8 +199,8 @@ blockquote {
}

.toc-label {
font-weight:700;
font-size:10px;
font-weight: 700;
font-size: 10px;
.gg-menu-motion {
display: none;
}
Expand All @@ -229,9 +212,9 @@ blockquote {
background: white;
z-index: 1;
padding: 5px 0.6rem;
box-shadow: 1px 0 2px 0px rgba(0,0,0,0.2);
box-shadow: 1px 0 2px 0px rgba(0, 0, 0, 0.2);
}
#toc-depth-slider {
display:none;
display: none;
}
}
18 changes: 10 additions & 8 deletions assets/_variables.scss
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
/* You can override SASS variables here. */

$red: #ff0010;
$orange: #ff6f00;
$yellow: #ffef00;
$green: #90ff00;
$blue: #0090ff;
:root {
--cl-red: #ff0010;
--cl-orange: #ff6f00;
--cl-yellow: #ffef00;
--cl-green: #90ff00;
--cl-blue: #0090ff;
--cl-gray: #6c8293;

$book-search-results-bg: #f8f9fa !default;
$color-link: $blue;
--color-link: var(--cl-blue);
--color-visited-link: var(--cl-blue);
}
46 changes: 0 additions & 46 deletions assets/dark-mode/dark-mode.js

This file was deleted.

Loading

0 comments on commit 12718a8

Please sign in to comment.