Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding license, readme, gitignore, and github codeowners
- Loading branch information
Showing
8 changed files
with
199 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# editorconfig.org | ||
|
||
root = true | ||
|
||
[*] | ||
charset = utf-8 | ||
indent_size = 2 | ||
indent_style = space | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
|
||
[*.md] | ||
trim_trailing_whitespace = false | ||
|
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* @oliverschmidt @DevoKun |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
.DS_Store | ||
*.bak | ||
*~ | ||
*.exe | ||
*.msi | ||
*.zip | ||
*.bin | ||
*.7z | ||
*.tar.gz | ||
*.tar.bz2 | ||
.project | ||
|
||
_sites | ||
_site | ||
node_modules | ||
package-lock.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2016 David Malone | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,147 @@ | ||
ProDOS-8 Website | ||
================ | ||
|
||
|
||
|
||
## Requirements for editing the site | ||
|
||
|
||
|
||
### For editing HTML files-only | ||
|
||
* Just a text editor like that respects UNIX newline characters and won't insert a bunch of Windows return chars or old Mac line-endings. | ||
* Decent editors would include things like: **vim**, **nano**, **[Atom](http://atom.io)**, or **[Sublime Text](http://www.sublimetext.com/)** | ||
|
||
|
||
|
||
### Required for building and serving locally | ||
|
||
* The site is built using **[Jekyll](https://jekyllrb.com/)**, *the static website builder*. | ||
* Jekyll allows the site to built dynamically, but served statically. | ||
* A static site makes it easy to host, on something like **AWS S3+CloudFront.** | ||
* The static site is lightning fast to load as there isn't any server-side processing of the page. | ||
* ***To build the site you will need to have Jekyll installed.*** | ||
* Jekyll is a ruby-based app, so **Ruby will need to be installed** to support Jekyll. | ||
* Not all versions of Ruby are created equal, *so ensure Ruby is a recent version using **[RVM][http://www.rvm.io/]**.* | ||
|
||
```bash | ||
gpg --keyserver hkp://keys.gnupg.net \ | ||
--recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 \ | ||
7D2BAF1CF37B13E2069D6956105BD0E739499BDB | ||
|
||
curl -sSL https://get.rvm.io | bash -s stable | ||
|
||
rvm osx-ssl-certs | ||
rvm list known | grep "^\[ruby-\]" | ||
rvm install ruby-2.4.1 | ||
rvm list | ||
rvm use ruby-2.4.1 | ||
|
||
gem install bundler jekyll | ||
|
||
``` | ||
|
||
|
||
|
||
### Required for rebuilding the CSS using SASS | ||
|
||
* SASS is a CSS pre-compiler. | ||
* SASS allows CSS to be built in a sophisticated way allowing re-usable code instead of having redundancies everywhere. | ||
* The CSS is compiled from the source in the **_scss** directory using the [sass precompiler](http://sass-lang.com/). | ||
* SASS is javascript based and **requires [NodeJS](https://nodejs.org/)** to be installed. | ||
* After installing [NodeJS](https://nodejs.org/), using **npm** to install all the dependencies: | ||
|
||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
|
||
|
||
## Using Gulp to perform functions in a repeatable way | ||
|
||
|
||
### Using Gulp | ||
|
||
* List the available gulp tasks: | ||
|
||
```bash | ||
gulp --tasks | ||
gulp --tasks-simple | ||
``` | ||
|
||
![gulp --tasks](_gulp_tasks.gif) | ||
|
||
|
||
|
||
### Running just `gulp` will compile the sass and compile the jekyll site | ||
|
||
```bash | ||
gulp | ||
``` | ||
|
||
|
||
|
||
### Compile files from _scss into both _site/css *(for live injecting)* and site *(for future jekyll builds)* | ||
|
||
```bash | ||
gulp sass | ||
``` | ||
|
||
![gulp sass](_gulp_sass.gif) | ||
|
||
|
||
|
||
|
||
### Compile and minify Javascript into one bundle file | ||
|
||
```bash | ||
gulp js | ||
``` | ||
|
||
|
||
|
||
|
||
|
||
## Building and Viewing the website locally | ||
|
||
|
||
|
||
### Jekyll can build the site | ||
|
||
```bash | ||
jekyll build | ||
``` | ||
|
||
* After running the **build** command, the site contents will be in the **_site** directory. | ||
* The contents of the _site directory are what would be hosted on something like S3: | ||
|
||
``` | ||
aws s3 sync _site/ s3://prodos8.com/ | ||
``` | ||
|
||
* GitHub Pages are Jekyll aware, and will take the **_site** directory content to populate a hosted page. | ||
|
||
|
||
|
||
### Jekyll can serve the site | ||
|
||
```bash | ||
jekyll serve | ||
``` | ||
|
||
![jekyll serve](_jekyll_serve.gif) | ||
|
||
* After running the **serve** command, Jekyll will start a webserver running on port 4000. | ||
* Point your web browser to http://0.0.0.0:4000/ to view the site. | ||
|
||
|
||
|
||
|
||
|
||
## Built using Jekyll and Bootstrap 4 | ||
|
||
- Built on the foundation of the **[jekyll-bootstrap-4](https://github.com/soulroll/jekyll-bootstrap-4)** theme from soulroll | ||
|
||
|
||
|
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.