Skip to content

Commit

Permalink
Init website
Browse files Browse the repository at this point in the history
  • Loading branch information
Korbeil committed Jan 3, 2020
1 parent f1a76cd commit 04db08a
Show file tree
Hide file tree
Showing 22 changed files with 10,255 additions and 0 deletions.
20 changes: 20 additions & 0 deletions website/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
33 changes: 33 additions & 0 deletions website/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Website

This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.

### Installation

```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

```
$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

Large diffs are not rendered by default.

94 changes: 94 additions & 0 deletions website/blog/2019-11-12-jane-5-0-has-been-released.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
---
id: jane-5-0-has-been-released
title: Jane 5.0 has been released! 🍾
author: Baptiste Leduc
author_title: Web consultant & Rum drinker
author_url: https://github.com/Korbeil
author_image_url: https://jolicode.com/media/cache/team_thumbnail/media/original/team/baptiste-leduc.jpg
tags: [Swagger, OpenAPI, API, PSR-18]
---

Jane is a set of libraries to generate models & API clients based on OpenApi specs. It will generate everything you need to use your API such as endpoints and related exceptions if needed.

As a reminder, OpenApi Specification is an API description format or API definition language. Basically, an OpenApi Specification allows you to describe an API including (among other things):
- General information about the API
- Available paths (`/resources`)
- Available operations on each path (`get /resources`)
- Input/Output for each operation

The previous version of JanePHP was released in February 2018 and used [OpenApi 2 specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md), async support and our first documentation.

Since that release, [Jane’s OpenApi library](https://github.com/janephp/open-api) has been installed more than 40,000 times 🎉.

At JoliCode, we are using Jane in a lot of different projects, to make API communication simpler and to build full API clients, such as: [Slack](https://github.com/jolicode/slack-php-api), [Docker](https://github.com/docker-php/docker-php-api), [Harvest](https://github.com/jolicode/harvest-php-api) or [Forecast](https://github.com/jolicode/forecast-php-api).

## Why is Jane 5 cooler than 4? 😎

A year after the previous version, we chose to release Jane 5.0 with two major features:

### OpenApi 3.0.2 support 📝

Since Swagger 2.0 (OpenApi is the new name of Swagger), a lot of changes has been made:
- `definitions` becomes `components/schemas`;
- Inside endpoint parameters, model definition is now indexed by a `schema` key;
- Again in endpoint parameters, `in: body` objects have a new separated field called `requestBody`;
- Better support for content-type negotiation.

Many other features can be found on [OpenApi 3.0 release blog post](https://swagger.io/blog/news/announcing-openapi-3-0/) or [the very detailed ReadMe blog post](https://blog.readme.io/an-example-filled-guide-to-swagger-3-2/).

### PSR-18 Client generation 🛠

[PSR-18](https://www.php-fig.org/psr/psr-18/) is a standard made by [PHP-FIG](https://www.php-fig.org/) to harmonize HTTP Clients among PHP.

This allows us to use any PSR-18 compatible client (including Symfony's [HttpClient](https://symfony.com/doc/current/components/http_client.html#psr-18) component). With this release it's preferable to use a PSR-18 Client than [HTTPlug](http://httplug.io/).

## A quick example 🔎

First, you'll need to require jane-php packages:
```bash
composer require --dev jane-php/open-api "^5.0"
composer require jane-php/open-api-runtime "^5.0"
```

OpenApi package is only needed to generate classes. OpenApiRuntime is needed to use theses classes.

Now, we need to configure Jane before generation. We create a `.jane-openapi` file:
```php
return [
'openapi-file' => __DIR__ . '/schema.yaml',
'namespace' => 'CatFacts\Api',
'directory' => __DIR__ . '/generated/',
];
```

It will contain a reference to your main schema file, the PHP namespace you want for generated classes and the directory you want to use. Other configuration can be made in that file, [read more in the documentation about it](https://jane.readthedocs.io/en/latest/OpenAPI/generate.html#configuration-file). Also, the schema used here can be found [in the documentation with more details](https://jane.readthedocs.io/en/latest/OpenAPI/example.html#openapi-schema).

After that, one line will generate classes based on your schema:
```bash
$ vendor/bin/jane-openapi generate
```

Then you can use them to communicate with your API 🎉
```bash
$ tree generated/
generated/
├── Client.php
├── Endpoint
│   └── RandomFact.php
├── Model
│   └── Fact.php
└── Normalizer
├── FactNormalizer.php
└── NormalizerFactory.php

3 directories, 5 files
```


## Want to go further? 🚶

Here is the [full working example](https://github.com/janephp/openapi3-example) or read the [documentation](https://jane.readthedocs.io/en/latest/OpenAPI/example.html).

We are using Jane every day and on many projects, we will continue to update and implement more features. If you want to contribute, you can help us by checking [issues](https://github.com/janephp/janephp/issues).
If you don’t know how to contribute, you can follow our guide about [contributing on Jane](https://github.com/janephp/janephp/blob/master/CONTRIBUTING.md) and [how the library works](https://jane.readthedocs.io/en/latest/internal.html).

168 changes: 168 additions & 0 deletions website/docs/doc1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,168 @@
---
id: doc1
title: Style Guide
sidebar_label: Style Guide
---

You can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/).

## Markdown Syntax

To serve as an example page when styling markdown based Docusaurus sites.

## Headers

# H1 - Create the best documentation

## H2 - Create the best documentation

### H3 - Create the best documentation

#### H4 - Create the best documentation

##### H5 - Create the best documentation

###### H6 - Create the best documentation

---

## Emphasis

Emphasis, aka italics, with _asterisks_ or _underscores_.

Strong emphasis, aka bold, with **asterisks** or **underscores**.

Combined emphasis with **asterisks and _underscores_**.

Strikethrough uses two tildes. ~~Scratch this.~~

---

## Lists

1. First ordered list item
1. Another item ⋅⋅\* Unordered sub-list.
1. Actual numbers don't matter, just that it's a number ⋅⋅1. Ordered sub-list
1. And another item.

⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).

⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅ ⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅ ⋅⋅⋅(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)

- Unordered list can use asterisks

* Or minuses

- Or pluses

---

## Links

[I'm an inline-style link](https://www.google.com)

[I'm an inline-style link with title](https://www.google.com "Google's Homepage")

[I'm a reference-style link][arbitrary case-insensitive reference text]

[I'm a relative reference to a repository file](../blob/master/LICENSE)

[You can use numbers for reference-style link definitions][1]

Or leave it empty and use the [link text itself].

URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com or <http://www.example.com> and sometimes example.com (but not on Github, for example).

Some text to show that the reference links can follow later.

[arbitrary case-insensitive reference text]: https://www.mozilla.org
[1]: http://slashdot.org
[link text itself]: http://www.reddit.com

---

## Images

Here's our logo (hover to see the title text):

Inline-style: ![alt text](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png 'Logo Title Text 1')

Reference-style: ![alt text][logo]

[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png 'Logo Title Text 2'

---

## Code

```javascript
var s = 'JavaScript syntax highlighting';
alert(s);
```

```python
s = "Python syntax highlighting"
print s
```

```
No language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.
```

```js {2}
function highlightMe() {
console.log('This line can be highlighted!');
}
```

---

## Tables

Colons can be used to align columns.

| Tables | Are | Cool |
| ------------- | :-----------: | -----: |
| col 3 is | right-aligned | \$1600 |
| col 2 is | centered | \$12 |
| zebra stripes | are neat | \$1 |

There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.

| Markdown | Less | Pretty |
| -------- | --------- | ---------- |
| _Still_ | `renders` | **nicely** |
| 1 | 2 | 3 |

---

## Blockquotes

> Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.
Quote break.

> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can _put_ **Markdown** into a blockquote.
---

## Inline HTML

<dl>
<dt>Definition list</dt>
<dd>Is something people use sometimes.</dd>

<dt>Markdown in HTML</dt>
<dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>
</dl>

---

## Line Breaks

Here's a line for us to start with.

This line is separated from the one above by two newlines, so it will be a _separate paragraph_.

This line is also a separate paragraph, but... This line is only separated by a single newline, so it's a separate line in the _same paragraph_.
6 changes: 6 additions & 0 deletions website/docs/doc2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
id: doc2
title: Document Number 2
---

This is a link to [another document.](doc3.md) This is a link to an [external page.](http://www.example.com)
14 changes: 14 additions & 0 deletions website/docs/doc3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
id: doc3
title: This is Document Number 3
---

Lorem ipsum dolor sit amet, consectetur adipiscing elit. In ac euismod odio, eu consequat dui. Nullam molestie consectetur risus id imperdiet. Proin sodales ornare turpis, non mollis massa ultricies id. Nam at nibh scelerisque, feugiat ante non, dapibus tortor. Vivamus volutpat diam quis tellus elementum bibendum. Praesent semper gravida velit quis aliquam. Etiam in cursus neque. Nam lectus ligula, malesuada et mauris a, bibendum faucibus mi. Phasellus ut interdum felis. Phasellus in odio pulvinar, porttitor urna eget, fringilla lectus. Aliquam sollicitudin est eros. Mauris consectetur quam vitae mauris interdum hendrerit. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Duis et egestas libero, imperdiet faucibus ipsum. Sed posuere eget urna vel feugiat. Vivamus a arcu sagittis, fermentum urna dapibus, congue lectus. Fusce vulputate porttitor nisl, ac cursus elit volutpat vitae. Nullam vitae ipsum egestas, convallis quam non, porta nibh. Morbi gravida erat nec neque bibendum, eu pellentesque velit posuere. Fusce aliquam erat eu massa eleifend tristique.

Sed consequat sollicitudin ipsum eget tempus. Integer a aliquet velit. In justo nibh, pellentesque non suscipit eget, gravida vel lacus. Donec odio ante, malesuada in massa quis, pharetra tristique ligula. Donec eros est, tristique eget finibus quis, semper non nisl. Vivamus et elit nec enim ornare placerat. Sed posuere odio a elit cursus sagittis.

Phasellus feugiat purus eu tortor ultrices finibus. Ut libero nibh, lobortis et libero nec, dapibus posuere eros. Sed sagittis euismod justo at consectetur. Nulla finibus libero placerat, cursus sapien at, eleifend ligula. Vivamus elit nisl, hendrerit ac nibh eu, ultrices tempus dui. Nam tellus neque, commodo non rhoncus eu, gravida in risus. Nullam id iaculis tortor.

Nullam at odio in sem varius tempor sit amet vel lorem. Etiam eu hendrerit nisl. Fusce nibh mauris, vulputate sit amet ex vitae, congue rhoncus nisl. Sed eget tellus purus. Nullam tempus commodo erat ut tristique. Cras accumsan massa sit amet justo consequat eleifend. Integer scelerisque vitae tellus id consectetur.
17 changes: 17 additions & 0 deletions website/docs/mdx.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
id: mdx
title: Powered by MDX
---

You can write JSX and use React components within your Markdown thanks to [MDX](https://mdxjs.com/).

export const Highlight = ({children, color}) => ( <span style={{
backgroundColor: color,
borderRadius: '2px',
color: '#fff',
padding: '0.2rem',
}}> {children} </span> );

<Highlight color="#25c2a0">Docusaurus green</Highlight> and <Highlight color="#1877F2">Facebook blue</Highlight> are my favorite colors.

I can write **Markdown** alongside my _JSX_!

0 comments on commit 04db08a

Please sign in to comment.