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.

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

[#242] use HTTPS #254

Merged
merged 1 commit into from
Aug 5, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ First of all, **thank you** for contributing!

Here are a few rules to follow in order to ease code reviews and merging:

- follow [PSR-1](http://www.php-fig.org/psr/1/) and [PSR-2](http://www.php-fig.org/psr/2/)
- follow [PSR-1](https://www.php-fig.org/psr/psr-1/) and [PSR-2](https://www.php-fig.org/psr/psr-2/)
- run the test suite
- write (or update) unit tests when applicable
- write documentation for new features
- use [commit messages that make sense](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
- use [commit messages that make sense](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)

One may ask you to [squash your commits](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) too. This is used to "clean" your pull request before merging it (we don't want commits such as `fix tests`, `fix 2`, `fix 3`, etc.).

Expand Down Expand Up @@ -40,7 +40,7 @@ Then you can run `bin/couscous preview`.

## Building the phar

To generate the phar yourself, you need to allow Phar generation in your `php.ini` ([`phar.readonly = Off`](http://us1.php.net/manual/en/phar.configuration.php#ini.phar.readonly)).
To generate the phar yourself, you need to allow Phar generation in your `php.ini` ([`phar.readonly = Off`](https://www.php.net/manual/en/phar.configuration.php#ini.phar.readonly)).

You also need to be able to use the `sha1sum` cli tool.

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
layout: home
---

Couscous generates a [GitHub pages](http://pages.github.com/) website from your markdown documentation.
Couscous generates a [GitHub pages](https://pages.github.com/) website from your markdown documentation.

[![Build Status](https://travis-ci.org/CouscousPHP/Couscous.svg?branch=master)](https://travis-ci.org/CouscousPHP/Couscous)
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/CouscousPHP/Couscous.svg)](http://isitmaintained.com/project/CouscousPHP/Couscous "Average time to resolve an issue")
[![Percentage of issues still open](http://isitmaintained.com/badge/open/CouscousPHP/Couscous.svg)](http://isitmaintained.com/project/CouscousPHP/Couscous "Percentage of issues still open")
[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/CouscousPHP/Couscous.svg)](https://isitmaintained.com/project/CouscousPHP/Couscous "Average time to resolve an issue")
[![Percentage of issues still open](https://isitmaintained.com/badge/open/CouscousPHP/Couscous.svg)](https://isitmaintained.com/project/CouscousPHP/Couscous "Percentage of issues still open")

**Everything is documented on [couscous.io](http://couscous.io/).**
**Everything is documented on [couscous.io](https://couscous.io/).**

What follows is the documentation for contributors.

Expand Down Expand Up @@ -58,7 +58,7 @@ class PutCouscousInBold implements \Couscous\Step
}
```

Couscous uses [PHP-DI](http://php-di.org/) for wiring everything together with dependency injection.
Couscous uses [PHP-DI](https://php-di.org/) for wiring everything together with dependency injection.

The full list of steps is configured in [`src/Application/config.php`](src/Application/config.php).

Expand Down
2 changes: 1 addition & 1 deletion couscous.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ scripts:
before:
- lessc --clean-css website/less/main.less website/css/all.min.css

baseUrl: http://couscous.io
baseUrl: https://couscous.io
cname: couscous.io

menu:
Expand Down
6 changes: 3 additions & 3 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ title: Hello!

# Base URL of the published website (no "/" at the end!)
# You are advised to set and use this variable to write your links in the HTML layouts
baseUrl: http://username.github.io/your-project
baseUrl: https://username.github.io/your-project
```
**Note:** any variable you put in `couscous.yml` is called **Metadata**. You can use these variables in templates for example. Learn more about this in the [Metadata documentation](metadata.md).
Expand All @@ -65,13 +65,13 @@ To use a CNAME for your Couscous-generated documentation so that your docs point
Metadata can also be specified from the command line:

```bash
$ couscous generate --config baseUrl=http://prod.server.com --config "fooBar=Baz Qux"
$ couscous generate --config baseUrl=https://prod.server.com --config "fooBar=Baz Qux"
```

This command will work exactly as if the following text was included in `couscous.yml`:

```yaml
baseUrl: http://prod.server.com
baseUrl: https://prod.server.com
fooBar: Baz Qux
```

Expand Down
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Links in Markdown are rewritten to link to HTML pages:

#### Can I use it for a blog?

Probably not yet, but you are welcome to try. [PHP-DI's website](http://php-di.org/news/) has a pseudo-blog where the article list is written manually: it's possible, but not (yet) super easy.
Probably not yet, but you are welcome to try. [PHP-DI's website](https://php-di.org/news/) has a pseudo-blog where the article list is written manually: it's possible, but not (yet) super easy.

#### Can I deploy the website to something else than GitHub Pages?

Expand Down
10 changes: 5 additions & 5 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Couscous requires PHP 5.4 or above on your machine.

### Composer

If you have already [set up a global install of Composer](http://akrabat.com/php/global-installation-of-php-tools-with-composer/) just run:
If you have already [set up a global install of Composer](https://akrabat.com/php/global-installation-of-php-tools-with-composer/) just run:

```
$ composer global require couscous/couscous
Expand All @@ -24,10 +24,10 @@ If you rather have it self-contained, use the **Phar** method just below.

### Phar

Alternatively, you can download [couscous.phar](http://couscous.io/couscous.phar):
Alternatively, you can download [couscous.phar](https://couscous.io/couscous.phar):

```bash
$ curl -OSL http://couscous.io/couscous.phar
$ curl -OSL https://couscous.io/couscous.phar
```

**Please note that as Github is using a DDOS protection system, if using CURL fails, just manually download the phar file.**
Expand Down Expand Up @@ -73,7 +73,7 @@ $ couscous deploy

Couscous will generate the website (in a temp directory) and publish it in the `gh-pages` branch of your git repository. This will remove everything that exists in the `gh-pages` branch, commit in your name, and **push** to GitHub.

The website is now online: [http://your-username.github.io/your-project/](http://your-username.github.io/your-project/).
The website is now online: [https://your-username.github.io/your-project/](https://your-username.github.io/your-project/).

The `deploy` command will not change anything in your current branch (e.g. master branch). It will only affect the `gh-pages` branch.

Expand All @@ -87,7 +87,7 @@ $ couscous deploy --branch master

## Customizing the template

Couscous provides [a default template](https://github.com/CouscousPHP/Template-Light) (and a [few others to choose from](http://couscous.io/templates.html)), but you can of course come up with your own. Writing templates is really simple, and it is all explained in the [templates documentation](templates.md).
Couscous provides [a default template](https://github.com/CouscousPHP/Template-Light) (and a [few others to choose from](https://couscous.io/templates.html)), but you can of course come up with your own. Writing templates is really simple, and it is all explained in the [templates documentation](templates.md).

## Updating Couscous

Expand Down
6 changes: 3 additions & 3 deletions docs/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ It allows many projects to reuse the same template.
To write a remote template, just write a normal template inside a directory (read below for understanding how).
Then publish that directory online (for example on GitHub).

You can find some examples of templates [here](http://couscous.io/templates.html).
You can find some examples of templates [here](https://couscous.io/templates.html).
The [Basic](https://github.com/CouscousPHP/Template-Basic) template is a good way to start.

*ProTip:* To preview your template, you can use `couscous preview` (Couscous will use your template's Readme). In order to tell Couscous that the template is in the root of the repository (and not in a `website/` subdirectory), use the following configuration:
Expand Down Expand Up @@ -64,7 +64,7 @@ that overrides `default.twig`:
{% endblock %}
```

You can set your `README.md` (i.e. your home page) to use that layout using [YAML front matter](http://jekyllrb.com/docs/frontmatter/) in the Markdown file:
You can set your `README.md` (i.e. your home page) to use that layout using [YAML front matter](https://jekyllrb.com/docs/frontmatter/) in the Markdown file:

```markdown
---
Expand Down Expand Up @@ -153,4 +153,4 @@ A good rule of thumb is: **if it works on GitHub.com, it will work with Couscous
If a `bower.json` file is present in the `website/` directory, dependencies will be
installed automatically.

In that case, you need [to have Bower installed](http://bower.io/). If you don't have a `bower.json`, you don't need to install Bower.
In that case, you need [to have Bower installed](https://bower.io/). If you don't have a `bower.json`, you don't need to install Bower.
2 changes: 1 addition & 1 deletion docs/travis.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ In order to push to your repository from Travis, you need to authorize Travis. Y

- from your GitHub account, go in [*Settings > Personal access tokens*](https://github.com/settings/tokens)
- create a new **Personal Access Token** and give it the `public_repo` permission (if the repository is public)
- install the [Travis command line tool](http://blog.travis-ci.com/2013-01-14-new-client/)
- install the [Travis command line tool](https://blog.travis-ci.com/2013-01-14-new-client/)

`gem install travis`

Expand Down
4 changes: 2 additions & 2 deletions src/Application/Cli/SelfUpdateCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ protected function configure()
protected function execute(InputInterface $input, OutputInterface $output)
{
$updater = new Updater(null, false);
$updater->getStrategy()->setPharUrl('http://couscous.io/couscous.phar');
$updater->getStrategy()->setVersionUrl('http://couscous.io/couscous.version');
$updater->getStrategy()->setPharUrl('https://couscous.io/couscous.phar');
$updater->getStrategy()->setVersionUrl('https://couscous.io/couscous.version');

$result = $updater->update();
$result ? $output->writeln('Phar file updated successfully!') : $output->writeln('No need to update.');
Expand Down
2 changes: 1 addition & 1 deletion tests/UnitTest/Module/Core/Step/AddCnameTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public function it_should_add_the_cname_file()
$project = new Project('foo', 'bar');

$project->metadata = new Metadata();
$project->metadata['cname'] = 'http://www.couscous.io';
$project->metadata['cname'] = 'https://www.couscous.io';

$step = new AddCname();
$step->__invoke($project);
Expand Down
4 changes: 2 additions & 2 deletions tests/UnitTest/Module/Markdown/Step/RenderMarkdownTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public function testClassicMarkdown()
##### Title 5
###### Title 6
Hello *world*! This is a [link](http://github.com).
Hello *world*! This is a [link](https://github.com).
this is a
code block
Expand All @@ -49,7 +49,7 @@ public function testClassicMarkdown()
<h4>Title 4</h4>
<h5>Title 5</h5>
<h6>Title 6</h6>
<p>Hello <em>world</em>! This is a <a href="http://github.com">link</a>.</p>
<p>Hello <em>world</em>! This is a <a href="https://github.com">link</a>.</p>
<pre><code>this is a
code block</code></pre>
<blockquote>
Expand Down
12 changes: 6 additions & 6 deletions website/default.twig
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
<link href="{{ baseUrl }}/css/all.min.css" rel="stylesheet">

<!-- Custom Fonts -->
<link href="http://maxcdn.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.min.css" rel="stylesheet" type="text/css">
<link href="http://fonts.googleapis.com/css?family=Montserrat:400,700" rel="stylesheet" type="text/css">
<link href='http://fonts.googleapis.com/css?family=Kaushan+Script' rel='stylesheet' type='text/css'>
<link href='http://fonts.googleapis.com/css?family=Droid+Serif:400,700,400italic,700italic' rel='stylesheet' type='text/css'>
<link href='http://fonts.googleapis.com/css?family=Roboto+Slab:400,100,300,700' rel='stylesheet' type='text/css'>
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.min.css" rel="stylesheet" type="text/css">
<link href="https://fonts.googleapis.com/css?family=Montserrat:400,700" rel="stylesheet" type="text/css">
<link href='https://fonts.googleapis.com/css?family=Kaushan+Script' rel='stylesheet' type='text/css'>
<link href='https://fonts.googleapis.com/css?family=Droid+Serif:400,700,400italic,700italic' rel='stylesheet' type='text/css'>
<link href='https://fonts.googleapis.com/css?family=Roboto+Slab:400,100,300,700' rel='stylesheet' type='text/css'>

<link rel="icon" type="image/png" href="logo/favicon-32x32.png" sizes="32x32" />
<link rel="icon" type="image/png" href="logo/favicon-16x16.png" sizes="16x16" />
Expand Down Expand Up @@ -125,7 +125,7 @@
g.defer=true; g.async=true; g.src=u+'piwik.js'; s.parentNode.insertBefore(g,s);
})();
</script>
<noscript><p><img src="http://mnapoli.piwikpro.com/piwik.php?idsite=2" style="border:0;" alt="" /></p></noscript>
<noscript><p><img src="https://mnapoli.piwikpro.com/piwik.php?idsite=2" style="border:0;" alt="" /></p></noscript>
<!-- End Piwik Code -->
{% endblock %}

Expand Down
10 changes: 5 additions & 5 deletions website/home-portfolio.twig
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
</div>
</div>
<div class="col-md-4 col-sm-6 portfolio-item">
<a href="http://php-di.org" class="portfolio-link">
<a href="https://php-di.org" class="portfolio-link">
<div class="portfolio-hover">
<div class="portfolio-hover-content">
<i class="fa fa-search fa-3x"></i>
Expand All @@ -43,7 +43,7 @@
</div>
</div>
<div class="col-md-4 col-sm-6 portfolio-item">
<a href="http://gnugat.github.io/redaktilo/" class="portfolio-link">
<a href="https://gnugat.github.io/redaktilo/" class="portfolio-link">
<div class="portfolio-hover">
<div class="portfolio-hover-content">
<i class="fa fa-search fa-3x"></i>
Expand All @@ -62,7 +62,7 @@

<div class="row">
<div class="col-md-4 col-sm-6 portfolio-item">
<a href="http://myclabs.github.io/jquery.confirm/" class="portfolio-link">
<a href="https://myclabs.github.io/jquery.confirm/" class="portfolio-link">
<div class="portfolio-hover">
<div class="portfolio-hover-content">
<i class="fa fa-search fa-3x"></i>
Expand Down Expand Up @@ -94,7 +94,7 @@
</div>
</div>
<div class="col-md-4 col-sm-6 portfolio-item">
<a href="http://obullo.com/" class="portfolio-link">
<a href="https://obullo.com/" class="portfolio-link">
<div class="portfolio-hover">
<div class="portfolio-hover-content">
<i class="fa fa-search fa-3x"></i>
Expand Down Expand Up @@ -126,7 +126,7 @@
</div>
</div>
<div class="col-md-4 col-sm-6 portfolio-item">
<a href="http://myclabs.github.io/Work/" class="portfolio-link">
<a href="https://myclabs.github.io/Work/" class="portfolio-link">
<div class="portfolio-hover">
<div class="portfolio-hover-content">
<i class="fa fa-search fa-3x"></i>
Expand Down
10 changes: 5 additions & 5 deletions website/home.twig
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@
<p>
Couscous is different from other static websites generators like
<a href="https://sculpin.io/">Sculpin</a>
or <a href="http://jekyllrb.com/">Jekyll</a>.
or <a href="https://jekyllrb.com/">Jekyll</a>.
These are generic static websites generator, sometimes meant for blogs,
and using them to put documentation online is clunky.
They also all require a specific directory layout which is
Expand Down Expand Up @@ -152,7 +152,7 @@
<p>
Simply run:
</p>
<pre trim><code>curl -OS http://couscous.io/couscous.phar
<pre trim><code>curl -OS https://couscous.io/couscous.phar
php couscous.phar preview</code></pre>
<p><strong>Please note that as Github is using a DDOS protection system, if using CURL fails, just manually download the phar file.</strong></p>
<p>
Expand All @@ -177,21 +177,21 @@ php couscous.phar preview</code></pre>
</div>
<div class="col-md-3 col-md-offset-3 text-center">
<p>
<a href="http://en.wikipedia.org/wiki/Markdown_Extra">Markdown Extra</a> support
<a href="https://en.wikipedia.org/wiki/Markdown_Extra">Markdown Extra</a> support
</p>
<p>
Fenced code blocks
</p>
<p>
<a href="http://bower.io/">Bower</a> support
<a href="https://bower.io/">Bower</a> support
</p>
<p>
Responsive default templates
</p>
</div>
<div class="col-md-3 text-center">
<p>
<a href="http://twig.sensiolabs.org/">Twig</a> templates
<a href="https://twig.sensiolabs.org/">Twig</a> templates
</p>
<p>
YAML configuration
Expand Down