Skip to content

Commit f5e52ea

Browse files
committed
Clean up the repo's general files
- Update README with build instructions - Remove data.txt that had the annual report data - Add baseurl for the site
1 parent defd4e5 commit f5e52ea

File tree

3 files changed

+27
-190
lines changed

3 files changed

+27
-190
lines changed

README.md

+25-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,25 @@
1-
AnnualReport
1+
# CSUN AS Annual Report '16 - '17
2+
3+
The annual report website for [CSUN Associated Students](https://www.csun.edu/as/) built with [stakx](https://stakx.io/).
4+
5+
## Building
6+
7+
This is a standard stakx website and is compiled normally. This website is built with [0.1.x of stakx](https://github.com/stakx-io/stakx/releases), however it should be forwards compatible with the 0.2.x development version of stakx.
8+
9+
1. Download the latest stable release of stakx
10+
2. Build the site
11+
```
12+
stakx build
13+
```
14+
15+
## Structure
16+
17+
- `_departments` - Each department has its own Twig template with its respective data
18+
- `_layouts` - The base Twig templates that other pages or templates should extend
19+
- `_macros` - Helper Twig macros for to avoid repetition
20+
- `_sections` - Generic partial Twig templates used on the site
21+
- `_pages` - Contains all of the stakx PageViews
22+
23+
## License
24+
25+
All rights reserved.

_config.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Build Settings
2+
baseurl: /annual-report/2016-2017/
3+
24
exclude:
35
- assets/originals/
46
- assets/photoshop/
5-
- data.txt
67
- .idea/
78

89
pageviews:

data.txt

-188
This file was deleted.

0 commit comments

Comments
 (0)