Skip to content

Build corrections #62

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.

Sign up for GitHub

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

Open
Vertmo wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Build corrections #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a34b44d
Added a list of requirements for building the project to README
Vertmo Sep 20, 2018
746221d
Corrected some weird errors with binary strings in generate.py
Vertmo Sep 20, 2018
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
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,19 @@ GitHub Cards is available on jsdelivr now. Use widget hosted on jsdelivr:
<script src="https://cdn.jsdelivr.net/gh/lepture/github-cards@latest/jsdelivr/widget.js"></script>
```

## Building

If you want to work on this project locally, you'll first need to clone it `git clone https://github.com/lepture/github-cards`

Then you'll need to install a few build dependencies:

* [python3](https://www.python.org/) (if not already installed, through your favorite package manager)
* [npm](https://www.npmjs.com/) (through your favorite package manager, along with Node.js)
* [uglifyjs](https://www.npmjs.com/package/uglify-js) through `sudo npm install -g uglify-js`
* [cleancss](https://www.npmjs.com/package/clean-css-cli) through `sudo npm install -g clean-css-cli`

Once all of this is installed, you should be all set to build the site ! Use `make build` to do so. You can then view the site by opening _\_site/index.html_ in your browser of choice, and start making changes (you'll need to rebuild the site every time you change the files in _src/_)

## Contribution

This project is under the BSD License.
10 changes: 5 additions & 5 deletions generate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,15 @@ def create_card(theme):

css = shell(['cleancss', 'theme/%s.css' % theme])

with open('src/card.js', 'rb') as f:
with open('src/card.js', 'r') as f:
content = f.read()
content += GA % 'UA-21475122-2'

js = shell(['uglifyjs', '-m'], content)
js = shell(['uglifyjs', '-m'], content.encode())

out = html % (css, tinyhtml(template), js)
out = html % (css.decode(), tinyhtml(template), js.decode())
with open('cards/%s.html' % theme, 'wb') as f:
f.write(out)
f.write(out.encode())


def create_widget():
Expand All @@ -71,7 +71,7 @@ def create_widget():
'var base = "%s";' % url
)

js = shell(['uglifyjs', '-m'], content)
js = shell(['uglifyjs', '-m'], content.encode())
with open('jsdelivr/widget.js', 'wb') as f:
f.write(js)

Expand Down