Skip to content
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

Update README.md #335

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #335

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
221 changes: 1 addition & 220 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,220 +1 @@


# Hydejack

A boutique Jekyll theme for hackers, nerds, and academics.





[![Screenshot](https://hydejack.com/assets/img/blog/hydejack-9.jpg)][welcome]

Hydejack's cover page on a variety of screens.



**Hydejack** is a boutique Jekyll theme for hackers, nerds, and academics, with a focus on personal sites that are meant to impress.

It includes a blog that is suitable for both prose and technical documentation, a portfolio to showcase your projects, and a resume template that looks amazing on the web and in print.

> Your complete presence on the web — A [blog], [portfolio], and [resume].



## A Personal Site That Won't Disappear

**Hydejack** is 100% built on Open Source software, and is Open Source itself, save for parts of the PRO version. The PRO version is a one-time payment that gives you the right to use it forever.

Hydejack is all static sites. _HTML_. All you need is a web server --- any web server --- to have a professional web presence that lasts a lifetime.

## Download

There are two versions of **Hydejack**: The *Free Version* includes basic blogging functionality and most of Hydejack's [Features], such as dynamic page loading and advanced animations.

The *PRO Version* includes additional features for professionals, such as a [portfolio], [resume], [Dark Mode][dark], [Forms], [Built-In Search][search] and customizable cookie banners.

The table below shows what's included in each version:

| | Free | PRO |
|:------------------------------|:--------------:|:-------------------:|
| [Blog] | ✔ | ✔ |
| [Features] | ✔ | ✔ |
| [Documentation][docs] | ✔ | ✔ |
| [Portfolio] | | ✔ |
| Printable [Resume] | | ✔ |
| [Dark Mode][dark] | | ✔ |
| [Built-In Search][search] | | ✔ |
| [Custom Forms][forms] | | ✔ |
| [Newsletter Box][news] | | ✔ |
| [Grid layout][grid] | | ✔ |
| [Offline Support][ofln] | | ✔ |
| Table of Contents[^2] | | ✔ |
| Cookie Banner | | ✔ |
| No Hydejack Branding | | ✔ |
| License | [GPL-3.0][lic] | [PRO] |
| Source | [GitHub][src] | Included |
| __Price__ / Upgrade | __Free__ | __$99__ / $39 [^3] |
| | [__Download__][kit] <br/>-- or --<br/> [__Deploy to Netlify__][nfy] | [__Buy PRO__][buy] |




**Hydejack** started out as a free blogging theme for Jekyll — and continues to be so.

<!--posts-->


## An Impressive Portfolio
A portfolio that's guaranteed to be impressive — no matter what you put into it.

<!--projects-->


## A Printable Resume
Get a resume that's consistent across the board — whether it's on the web, mobile, print, or [PDF](https://hydejack.com/assets/Resume.pdf).

[![Resume PDF](https://hydejack.com/assets/img/blog/resume.png)][resume]

Front and center page of a print resume generated by Hydejack.



## Just Markdown
Write all content with Markdown. __Hydejack__ gives you [additional CSS classes](docs/writing.md) to stylize your content, without losing compatibility with other Jekyll themes.


## Just Markup
**Hydejack** boasts a plethora of modern JavaScript, but make no mistake: It's still a _plain old web page_ at its core. It works without JavaScript and you can even view it in a text-based browser like `w3m`:

![w3m Screenshot](https://hydejack.com/assets/img/blog/w3m.png)

The Hydejack blog, as seen by the text browser `w3m`.



## Syntax Highlighting
**Hydejack** features syntax highlighting, powered by [Rouge].

```js
// file: `example.js`
document.querySelector("hy-push-state").addEventListener("hy-push-state-load", () => {
const supportsCodeHighlights = true; //!!
});
```

Code blocks can have a filename and a caption.



## Beautiful Math
They say math is beautiful — and with **Hydejack**'s [math support][math] it's guaranteed to also look beautiful:

![Math example](https://hydejack.com/assets/img/blog/example-content-iii.jpg)

Hydejack uses KaTeX to efficiently render math.




## Build an Audience
The PRO version has built-in support for customizable [Tinyletter] newsletter subscription boxes.

If you are using a different service like MailChimp, you can build a custom newsletter subscription box using [Custom Forms][forms].




## Features

An incomplete list of features included in all versions of **Hydejack**:

* Responsive layout with unique design features for every screen size
* Cover Pages for a stunning fist impression.
* Customizable sidebar and touch-enabled drawer menu
* Single Page Web App-style page loading
* Advanced FLIP animations, inspired by Material Design
* Good [Google PageSpeed Score][gpss][^1]
* [Syntax highlighting][syntax], powered by [Rouge]
* [LaTeX math blocks][latex], rendered with ether [KaTeX] or [MathJax] at your choice
* Soft-coded labels: Change wording or translate to other languages via a single file
* Support for categories and tags
* Author section below each article and support for multiple authors
* Built-in icons for many social networks
* Simple and semantic HTML + Structured Data
* Google Analytics and Google Fonts support


## Comparison

There are two versions of **Hydejack**: The *Free Version* includes basic blogging functionality and most of Hydejack's [Features], such as dynamic page loading and advanced animations.

The *PRO Version* includes additional features for professionals, such as a [portfolio], [resume], [Dark Mode][dark], [Forms], [Built-In Search][search] and customizable cookie banners.

The table below shows what's included in each version:

| | Free | PRO |
|:------------------------------|:--------------:|:-------------------:|
| [Blog] | &#x2714; | &#x2714; |
| [Features] | &#x2714; | &#x2714; |
| [Documentation][docs] | &#x2714; | &#x2714; |
| [Portfolio] | | &#x2714; |
| Printable [Resume] | | &#x2714; |
| [Dark Mode][dark] | | &#x2714; |
| [Built-In Search][search] | | &#x2714; |
| [Custom Forms][forms] | | &#x2714; |
| [Newsletter Box][news] | | &#x2714; |
| [Grid layout][grid] | | &#x2714; |
| [Offline Support][ofln] | | &#x2714; |
| Table of Contents[^2] | | &#x2714; |
| Cookie Banner | | &#x2714; |
| No Hydejack Branding | | &#x2714; |
| License | [GPL-3.0][lic] | [PRO] |
| Source | [GitHub][src] | Included |
| __Price__ / Upgrade | __Free__ | __$99__ / $39 [^3] |
| | [__Download__][kit] <br/>-- or --<br/> [__Deploy to Netlify__][nfy] | [__Buy PRO__][buy] |

[^1]: Actual page load speed depends on your hosting provider, resolution of embedded images and usage of 3rd party plugins.

[^2]: Large screens (> 1664px width) only.

[^3]: Upgrading from Hydejack 8? Find your discount code in the latest zip download!

*[FLIP]: First-Last-Invert-Play. A coding technique to achieve performant page transition animations.


[blog]: https://hydejack.com/blog/
[portfolio]: https://hydejack.com/projects/
[resume]: https://hydejack.com/resume/
[download]: https://hydejack.com/download/
[welcome]: https://hydejack.com/
[forms]: https://hydejack.com/forms-by-example/

[features]: https://hydejack.com/#features
[news]: https://hydejack.com/#build-an-audience
[syntax]: https://hydejack.com/#syntax-highlighting
[latex]: https://hydejack.com/#beautiful-math
[dark]: https://hydejack.com/blog/hydejack/2018-09-01-introducing-dark-mode/
[search]: https://hydejack.com/#_search-input
[grid]: https://hydejack.com/blog/hydejack/

[lic]: LICENSE.md
[pro]: licenses/PRO.md
[docs]: https://hydejack.com/docs/
[ofln]: https://hydejack.com/docs/advanced/#enabling-offline-support
[math]: https://hydejack.com/docs/writing/#adding-math

[kit]: https://github.com/hydecorp/hydejack-starter-kit/releases
[src]: https://github.com/hydecorp/hydejack
[gem]: https://rubygems.org/gems/jekyll-theme-hydejack
[buy]: https://gum.co/nuOluY
[nfy]: https://app.netlify.com/start/deploy?repository=https://github.com/hydecorp/hydejack-starter-kit
[dtn]: https://www.netlify.com/img/deploy/button.svg

[gpss]: https://developers.google.com/speed/pagespeed/insights/?url=https://hydejack.com/
[hy-push-state]: https://hydecorp.github.io/hy-push-state/
[hy-drawer]: https://hydecorp.github.io/hy-drawer/
[rouge]: http://rouge.jneen.net
[katex]: https://khan.github.io/KaTeX/
[mathjax]: https://www.mathjax.org/
[tinyletter]: https://tinyletter.com/
#Associacao de estudantes escola secundario leal da camara