Skip to content

Commit

Permalink
feat: Apply prettier to generated markdown files for improved formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
AlanFoster committed Apr 30, 2019
1 parent e437afd commit 0e8bde4
Show file tree
Hide file tree
Showing 49 changed files with 1,257 additions and 2,669 deletions.
49 changes: 22 additions & 27 deletions examples/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,28 @@


# Readme


# Readme

## /

* [Abstract](./abstract.schema.md)`https://example.com/schemas/abstract` (Unknown)
* [Arrays](./arrays.schema.md)`https://example.com/schemas/arrays` (Unknown)
* [Complex References ](./complex.schema.md)`https://example.com/schemas/complex` (Unknown)
* [Constant Types](./constants.schema.md)`https://example.com/schemas/constants` (Unknown)
* [Custom](./custom.schema.md)`https://example.com/schemas/custom` (Unknown)
* [Deeply Extending](./deepextending.schema.md)`https://example.com/schemas/deepextending` (Unknown)
* [Definitions](./definitions.schema.md)`https://example.com/schemas/definitions` (Unknown)
* [Enumerated ](./enums.schema.md)`https://example.com/schemas/enums` (Unknown)
* [Example](./example.schema.md)`https://example.com/schemas/example` (Unknown)
* [Examples](./examples.schema.md)`https://example.com/schemas/examples` (Unknown)
* [Extending](./extending.schema.md)`https://example.com/schemas/extending` (Unknown)
* [Extensible](./extensible.schema.md)`https://example.com/schemas/extensible` (Unknown)
* [Identifiable](./identifiable.schema.md)`https://example.com/schemas/identifiable` (Unknown)
* [Join Types](./join.schema.md)`https://example.com/schemas/join` (Unknown)
* [Nested Object](./nestedobj.schema.md)`https://example.com/schemas/nestedobject` (Unknown)
* [Pattern Properties](./pattern.schema.md)`https://example.com/schemas/pattern` (Unknown)
* [Simple](./simple.schema.md)`https://example.com/schemas/simple` (Unknown)
* [Simple Types](./simpletypes.schema.md)`https://example.com/schemas/simpletypes` (Unknown)
* [Stabilizing](./stabilizing.schema.md)`https://example.com/schemas/stabilizing` (Stabilizing)
* [Type Arrays](./typearrays.schema.md)`https://example.com/schemas/typearrays` (Unknown)
- [Abstract](./abstract.schema.md)`https://example.com/schemas/abstract` (Unknown)
- [Arrays](./arrays.schema.md)`https://example.com/schemas/arrays` (Unknown)
- [Complex References ](./complex.schema.md)`https://example.com/schemas/complex` (Unknown)
- [Constant Types](./constants.schema.md)`https://example.com/schemas/constants` (Unknown)
- [Custom](./custom.schema.md)`https://example.com/schemas/custom` (Unknown)
- [Deeply Extending](./deepextending.schema.md)`https://example.com/schemas/deepextending` (Unknown)
- [Definitions](./definitions.schema.md)`https://example.com/schemas/definitions` (Unknown)
- [Enumerated ](./enums.schema.md)`https://example.com/schemas/enums` (Unknown)
- [Example](./example.schema.md)`https://example.com/schemas/example` (Unknown)
- [Examples](./examples.schema.md)`https://example.com/schemas/examples` (Unknown)
- [Extending](./extending.schema.md)`https://example.com/schemas/extending` (Unknown)
- [Extensible](./extensible.schema.md)`https://example.com/schemas/extensible` (Unknown)
- [Identifiable](./identifiable.schema.md)`https://example.com/schemas/identifiable` (Unknown)
- [Join Types](./join.schema.md)`https://example.com/schemas/join` (Unknown)
- [Nested Object](./nestedobj.schema.md)`https://example.com/schemas/nestedobject` (Unknown)
- [Pattern Properties](./pattern.schema.md)`https://example.com/schemas/pattern` (Unknown)
- [Simple](./simple.schema.md)`https://example.com/schemas/simple` (Unknown)
- [Simple Types](./simpletypes.schema.md)`https://example.com/schemas/simpletypes` (Unknown)
- [Stabilizing](./stabilizing.schema.md)`https://example.com/schemas/stabilizing` (Stabilizing)
- [Type Arrays](./typearrays.schema.md)`https://example.com/schemas/typearrays` (Unknown)

## /subdir/

* [Subdir](./subdir/subdir.schema.md)`https://example.com/schemas/subdir/subdir` (Unknown)

- [Subdir](./subdir/subdir.schema.md)`https://example.com/schemas/subdir/subdir` (Unknown)
52 changes: 17 additions & 35 deletions examples/docs/abstract.schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,76 +11,58 @@ https://example.com/schemas/abstract

This is an abstract schema. It has `definitions`, but does not declare any properties

| [Abstract](../abstract.md) | Extensible | [Status](../status.md) | Identifiable | Custom Properties | Additional Properties | Defined In |
|----------------------------|------------|------------------------|--------------|-------------------|-----------------------|------------|
| Cannot be instantiated | Yes | Experimental | No | Forbidden | Permitted | [abstract.schema.json](abstract.schema.json) |
| [Abstract](../abstract.md) | Extensible | [Status](../status.md) | Identifiable | Custom Properties | Additional Properties | Defined In |
| -------------------------- | ---------- | ---------------------- | ------------ | ----------------- | --------------------- | -------------------------------------------- |
| Cannot be instantiated | Yes | Experimental | No | Forbidden | Permitted | [abstract.schema.json](abstract.schema.json) |

# Abstract Definitions

| Property | Type | Group |
|----------|------|-------|
| [bar](#bar) | `string` | `https://example.com/schemas/abstract#/definitions/second` |
| [foo](#foo) | `string` | `https://example.com/schemas/abstract#/definitions/first` |
| [nonfoo](#nonfoo) | `const` | `https://example.com/schemas/abstract#/definitions/first` |
| Property | Type | Group |
| ----------------- | -------- | ---------------------------------------------------------- |
| [bar](#bar) | `string` | `https://example.com/schemas/abstract#/definitions/second` |
| [foo](#foo) | `string` | `https://example.com/schemas/abstract#/definitions/first` |
| [nonfoo](#nonfoo) | `const` | `https://example.com/schemas/abstract#/definitions/first` |

## bar

A unique identifier given to every addressable thing.

`bar`

* is optional
* type: `string`
* defined in this schema
- is optional
- type: `string`
- defined in this schema

### bar Type


`string`







## foo

A unique identifier given to every addressable thing.

`foo`

* is optional
* type: `string`
* defined in this schema
- is optional
- type: `string`
- defined in this schema

### foo Type


`string`







## nonfoo

This is not foo.

`nonfoo`

* is optional
* type: `const`
* defined in this schema
- is optional
- type: `const`
- defined in this schema

The value of this property **must** be equal to:

```json
false
```




Loading

0 comments on commit 0e8bde4

Please sign in to comment.