@@ -6,7 +6,7 @@ Source for creativecommons.github.io
6
6
## Overview
7
7
8
8
This site is built using [ Lektor] [ lektor ] . All changes to
9
- [ https://creativecommons.github.io ] [[ ccgithubio] must be made ** here** and
9
+ [ https://creativecommons.github.io ] [ ccgithubio ] must be made ** here** and
10
10
deployed via lektor (see [ Deploying] ( #deploying ) , below).
11
11
12
12
** DO NOT MAKE CHANGES TO THE [ creativecommons.github.io] [ ccghiorepo ] REPO
@@ -17,23 +17,35 @@ DIRECTLY**.
17
17
[ ccghiorepo ] :https://github.com/creativecommons/creativecommons.github.io
18
18
19
19
20
- ## Making changes
20
+ ## Installation
21
21
22
22
1 . Make sure you have [ pipenv] [ pipenvdocs ] installed.
23
23
1 . Clone this repository.
24
24
1 . Open your command line interface and ` cd ` to the repository root directory.
25
25
1 . Run ` pipenv install ` to create a Python virtual environment and install the
26
26
requirements for this project.
27
+
28
+ [ pipenvdocs ] :https://pipenv.readthedocs.io/en/latest/
29
+
30
+
31
+ ## Development
32
+
27
33
1 . Run ` pipenv shell ` to spawn a shell with the virtualenv activated
28
34
1 . Run ` lektor server ` to start the Lektor development server. You will be able
29
35
to see the website at [ ` http://localhost:5000/ ` ] [ lektorlocal ] . The Lektor
30
36
server will rebuild the site every time you change any content.
31
37
32
- [ pipenvdocs ] :https://pipenv.readthedocs.io/en/latest/
33
38
[ lektorlocal ] :http://localhost:5000/
34
39
35
40
36
- ## Project structure
41
+ ## Deploying
42
+
43
+ When you are ready to deploy a new version of the site, run ` lektor deploy `
44
+ (assuming you have your GitHub SSH key set up already). That's it, it's live on
45
+ production!
46
+
47
+
48
+ ## Project Structure
37
49
38
50
Here's how the code is structured in the top level of the repository:
39
51
- ` assets ` : This directory contains the JavaScript and CSS files for the
@@ -53,10 +65,3 @@ Here's how the code is structured in the top level of the repository:
53
65
[ lektormodels] :(https://www.getlektor.com/docs/models/
54
66
[ jinja2 ] :http://jinja.pocoo.org/
55
67
[ lektortemplate ] :https://www.getlektor.com/docs/templates/
56
-
57
-
58
- ## Deploying
59
-
60
- When you are ready to deploy a new version of the site, run ` lektor deploy `
61
- (assuming you have your GitHub SSH key set up already). That's it, it's live on
62
- production!
0 commit comments