Skip to content

Commit

Permalink
feat(content): use content from emdaer/emdaer as site sections (#12)
Browse files Browse the repository at this point in the history
* feat(content): use content from emdaer/emdaer as site sections

* docs: add section about site content to README

* docs: add toc
  • Loading branch information
infiniteluke authored Nov 20, 2017
1 parent 49d3275 commit ac88ad3
Show file tree
Hide file tree
Showing 7 changed files with 806 additions and 60 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@
"email": null,
"hireable": null,
"bio": "I build multi-channel publishing systems and web applications at @fourkitchens.",
"public_repos": 40,
"public_repos": 42,
"public_gists": 1,
"followers": 19,
"following": 56,
"following": 57,
"created_at": "2011-10-14T00:22:53Z",
"updated_at": "2017-10-15T23:18:57Z"
},
Expand Down Expand Up @@ -58,9 +58,9 @@
"bio": null,
"public_repos": 21,
"public_gists": 1,
"followers": 33,
"followers": 34,
"following": 15,
"created_at": "2012-01-05T15:20:07Z",
"updated_at": "2017-11-09T03:27:05Z"
"updated_at": "2017-11-16T05:40:52Z"
}
]
25 changes: 21 additions & 4 deletions .emdaer/README.emdaer.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,39 @@
- '@emdaer/plugin-value-from-package'
- value: description
-->
## Table of contents
<!-- toc -->
## Deployments

## Website
### Website
Travis autodeploys the website to GitHub Pages using its `deploy` configuration when changes are merged into the `site` branch. Being an [Organization Page](https://help.github.com/articles/user-organization-and-project-pages/), the website code is stored on the `master` branch.

### Pull Requests
Pull Request builds will run [surge-review](https://github.com/cdaringe/surge-review) via Travis' `after_success` hook on the highest node version build using [travis-deploy-once](https://github.com/semantic-release/travis-deploy-once). Once the deployment is sucessful, a comment from emdaerbot will be posted to the respective PR with a link to the built site. This can be used for design review and functional testing of Pull Requests. Each additional commit to the website source in the PR will rebuild the site and post a new link.

## Content
Some of the content on this website is shared from the [emdaer](https://github.com/emdaer/emdaer) readme via the [@emdaer/meta](https://www.npmjs.com/package/@emdaer/meta) package which exports the readme sections as template literals.

## Contributors
<!--emdaer-p
- '@emdaer/plugin-contributors-details-github'
-->

## Pull Requests
Pull Request builds will run [surge-review](https://github.com/cdaringe/surge-review) via Travis' `after_success` hook on the highest node version build using [travis-deploy-once](https://github.com/semantic-release/travis-deploy-once). Once the deployment is sucessful, a comment from emdaerbot will be posted to the respective PR with a link to the built site. This can be used for design review and functional testing of Pull Requests. Each additional commit to the website source in the PR will rebuild the site and post a new link.

## License
<!--emdaer-p
- '@emdaer/plugin-license-reference'
-->
<!--emdaer-t
- '@emdaer/transform-prettier'
- options:
printWidth: 500
singleQuote: true
trailingComma: es5
-->
<!--emdaer-t
- '@emdaer/transform-smartypants'
- options: q
-->
<!--emdaer-t
- '@emdaer/transform-table-of-contents'
-->
37 changes: 33 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,39 @@
-->

# emdaer.github.io · [![Travis](https://img.shields.io/travis/emdaer/emdaer.svg?style=flat-square)](https://travis-ci.org/emdaer/emdaer.github.io/) [![Documented with emdaer](https://img.shields.io/badge/📓-documented%20with%20emdaer-F06632.svg?style=flat-square)](https://github.com/emdaer/emdaer)

emdaer website

## Table of contents

<!-- toc -->

- [Deployments](#deployments)
* [Website](#website)
* [Pull Requests](#pull-requests)
- [Content](#content)
- [Contributors](#contributors)
- [License](#license)

<!-- tocstop -->

## Deployments

## Website
### Website

Travis autodeploys the website to GitHub Pages using its `deploy` configuration when changes are merged into the `site` branch. Being an [Organization Page](https://help.github.com/articles/user-organization-and-project-pages/), the website code is stored on the `master` branch.

### Pull Requests

Pull Request builds will run [surge-review](https://github.com/cdaringe/surge-review) via Travis&#8217; `after_success` hook on the highest node version build using [travis-deploy-once](https://github.com/semantic-release/travis-deploy-once). Once the deployment is sucessful, a comment from emdaerbot will be posted to the respective PR with a link to the built site. This can be used for design review and functional testing of Pull Requests. Each additional commit to the website source in the PR will
rebuild the site and post a new link.

## Content

Some of the content on this website is shared from the [emdaer](https://github.com/emdaer/emdaer) readme via the [@emdaer/meta](https://www.npmjs.com/package/@emdaer/meta) package which exports the readme sections as template literals.

## Contributors

<details>
<summary><strong>Contributors</strong></summary><br />
<a title="I build multi-channel publishing systems and web applications at @fourkitchens." href="https://github.com/infiniteluke">
Expand All @@ -24,9 +52,10 @@ Travis autodeploys the website to GitHub Pages using its `deploy` configuration
<br /><br />
</details>

## Pull Requests
Pull Request builds will run [surge-review](https://github.com/cdaringe/surge-review) via Travis&#8217; `after_success` hook on the highest node version build using [travis-deploy-once](https://github.com/semantic-release/travis-deploy-once). Once the deployment is sucessful, a comment from emdaerbot will be posted to the respective PR with a link to the built site. This can be used for design review and functional testing of Pull Requests. Each additional commit to the website source in the PR will rebuild the site and post a new link.

## License

emdaer.github.io is [MIT licensed](./LICENSE).




14 changes: 14 additions & 0 deletions gatsby-node.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
exports.modifyWebpackConfig = ({ config }) => {
// @TODO Remove this
// Beacuse webpack 1.x prefixes the bundle with tabs,imported template
// literals are indented incorrectly. Additionally, webpack-configurator does
// not allow sourcePrefix to be an empty string. Due to this, we need to add a
// single space which does not affect formatting. This is issue was fixed in
// webpack 2 and therefore will be fixed in Gatsby 2
config.merge({
output: {
sourcePrefix: ' ',
},
});
return config;
};
7 changes: 6 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@
"@emdaer/plugin-license-reference": "^1.2.1",
"@emdaer/plugin-shields": "^1.2.1",
"@emdaer/plugin-value-from-package": "^1.2.1",
"@emdaer/transform-prettier": "^1.6.16",
"@emdaer/transform-smartypants": "^1.2.1",
"@emdaer/transform-table-of-contents": "^1.6.16",
"babel-eslint": "^8.0.1",
"commitlint": "^4.2.2",
"eslint": "^4.9.0",
Expand All @@ -50,15 +52,18 @@
"travis-deploy-once": "^3.0.0"
},
"dependencies": {
"@emdaer/meta": "^1.6.16",
"bootstrap": "4.0.0-beta",
"gatsby": "^1.9.96",
"gatsby": "^1.9.118",
"gatsby-link": "^1.6.24",
"gatsby-plugin-glamor": "^1.6.8",
"gatsby-plugin-react-helmet": "^1.0.8",
"gatsby-plugin-typography": "^1.7.10",
"glamorous": "^4.11.0",
"react-icons": "^2.2.7",
"reactstrap": "^5.0.0-alpha.3",
"remark": "^8.0.0",
"remark-react": "^4.0.1",
"typography": "^0.16.6",
"typography-theme-bootstrap": "^0.16.7"
}
Expand Down
14 changes: 14 additions & 0 deletions src/pages/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
import React from 'react';
import g from 'glamorous';
import { Jumbotron } from 'reactstrap';
import remark from 'remark';
import reactRenderer from 'remark-react';
import whatIsEmdaer from '@emdaer/meta/lib/README/what-is-emdaer';
import howEmdaerWorks from '@emdaer/meta/lib/README/how-emdaer-works';
import addingEmdaer from '@emdaer/meta/lib/README/adding-emdaer-to-your-project';
import { rhythm } from '../utils/typography';

const createMarkup = content =>
remark()
.use(reactRenderer)
.processSync(content).contents;

const IndexPage = () => (
<div>
<g.Section
Expand All @@ -17,6 +28,9 @@ const IndexPage = () => (
Create and Maintain better READMEs
</g.P>
</g.Section>
<Jumbotron>{createMarkup(whatIsEmdaer)}</Jumbotron>
<g.Section>{createMarkup(howEmdaerWorks)}</g.Section>
<Jumbotron>{createMarkup(addingEmdaer)}</Jumbotron>
</div>
);

Expand Down
Loading

0 comments on commit ac88ad3

Please sign in to comment.