Skip to content

Commit 334d2d6

Browse files
cthoytcthoyt
authored
Lint HTML and markdown with prettier (OBOFoundry#2052)
* Add configuration and documentation * Update about-OBO-Foundry.html * Update .prettierignore * Apply prettier * Update .prettierignore * Update README-sitedev.md * Update README-sitedev.md * Update README-sitedev.md
1 parent 6e3eef2 commit 334d2d6

File tree

114 files changed

+2034
-1594
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

114 files changed

+2034
-1594
lines changed

‎.github/ISSUE_TEMPLATE/bug-or-question.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
name: Bug report or question
33
about: Report a problem on obofoundry.org or ask a question
4-
54
---
65

76
If you are reporting an issue with our website, please specify the URL you were looking at, which browser and OS you are using, and if possible,

‎.github/ISSUE_TEMPLATE/obo-foundry-principles.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22
name: OBO Foundry Principles
33
about: Suggestions regarding wording of (or additions to) principles
44
title: 'Principle #<ENTER NUMBER HERE> "<ENTER NAME HERE>"'
5-
labels: 'attn: Editorial WG'
5+
labels: "attn: Editorial WG"
66
assignees: nataled
7-
87
---
9-
10-

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,4 @@ share/python-wheels/
3030
.installed.cfg
3131
*.egg
3232
MANIFEST
33+
node_modules/

‎.prettierignore

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
_site
2+
*.yml
3+
*.css
4+
*.js
5+
*.json
6+
_includes/themes/
7+
ontology/
8+
legacy/
9+
README-sitedev.md
10+
README.md
11+
LICENSE-code.md
12+
LICENSE.md

‎CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ Thank you for taking the time to contribute. We appreciate it!
44

55
There are two ways to contribute to this effort. The first way is to use this project's [Issues Page](https://github.com/OBOFoundry/OBOFoundry.github.io/issues), which we use as a forum to discuss both major and minor issues related to developing the OBO repository, procedures and associated web interface. Examples of the type of issues that can be submitted are:
66

7-
* Issues to do with the website and other technical issues
8-
* Issues relating to metadata about individual ontologies
9-
* Issues regarding OBO as a whole
7+
- Issues to do with the website and other technical issues
8+
- Issues relating to metadata about individual ontologies
9+
- Issues regarding OBO as a whole
1010

1111
Please refer to the FAQ section [faq/how-do-i-edit-metadata.md](faq/how-do-i-edit-metadata.md) on making Pull Requests.
1212

13-
1413
<a name="issue_resolution"></a>
14+
1515
## Issue Resolution
1616

1717
Once a pull request or issue have been submitted, anyone can comment or vote on an issue to express their opinion following the Apache voting system. Quick summary:

‎README-sitedev.md

+6
Original file line numberDiff line numberDiff line change
@@ -145,3 +145,9 @@ current wiki, but other opinions welcome.
145145

146146
We use bootstrap 3, so far no themes.
147147

148+
### Code quality
149+
150+
1. Install the Node Package Manager (NPM) following [these instructions](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
151+
2. Install the [node package exector (`npx`)](https://www.npmjs.com/package/npx) with NPM using `npm install npx`
152+
2. Install [`prettier`](https://prettier.io) with NPM using `npm install prettier`
153+
3. Run `prettier` from the root of the repository with `npx prettier --write .`

‎_includes/aboutme.html

+73-34
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,83 @@
11
<p>
2-
<img
3-
src="{{ site.imgurl}}/u-logo.jpg" alt="logo"
4-
title="Follow us on Twitter @{{ site.author.twitter }}"
5-
class="img-rounded floatLeft"
6-
/>
2+
<img
3+
src="{{ site.imgurl}}/u-logo.jpg"
4+
alt="logo"
5+
title="Follow us on Twitter @{{ site.author.twitter }}"
6+
class="img-rounded floatLeft"
7+
/>
78

8-
OBO is an integrated cross-species ontology covering anatomical
9-
structures in animals. See the <a href="{{ site.baseurl}}about.html">about</a> page
10-
for more info.
11-
12-
</p>
13-
<p>
14-
<span class="icon search"></span>
15-
{% include ontobee_search.html %}
9+
OBO is an integrated cross-species ontology covering anatomical structures in
10+
animals. See the <a href="{{ site.baseurl}}about.html">about</a> page for more
11+
info.
1612
</p>
1713
<p>
18-
<h6>github.com/obophenotype/OBO</h6>
19-
<iframe
20-
class="github-btn"
21-
src="http://ghbtns.com/github-btn.html?user={{site.project.github.org }}&repo={{ site.project.github.repo }}&type=watch&count=true"
22-
allowtransparency="true"
23-
frameborder="0" scrolling="0" width="80px" height="20px">
24-
</iframe>&nbsp;
25-
<iframe class="github-btn"
26-
src="http://ghbtns.com/github-btn.html?user={{ site.project.github.org }}&repo={{ site.project.github.repo}}&type=fork&count=true"
27-
allowtransparency="true" frameborder="0" scrolling="0"
28-
width="98px" height="20px">
29-
</iframe>
14+
<span class="icon search"></span>
15+
{% include ontobee_search.html %}
3016
</p>
17+
<div>
18+
<h6>github.com/obophenotype/OBO</h6>
19+
<iframe
20+
class="github-btn"
21+
src="http://ghbtns.com/github-btn.html?user={{site.project.github.org }}&repo={{ site.project.github.repo }}&type=watch&count=true"
22+
allowtransparency="true"
23+
frameborder="0"
24+
scrolling="0"
25+
width="80px"
26+
height="20px"
27+
>
28+
</iframe
29+
>&nbsp;
30+
<iframe
31+
class="github-btn"
32+
src="http://ghbtns.com/github-btn.html?user={{ site.project.github.org }}&repo={{ site.project.github.repo}}&type=fork&count=true"
33+
allowtransparency="true"
34+
frameborder="0"
35+
scrolling="0"
36+
width="98px"
37+
height="20px"
38+
>
39+
</iframe>
40+
</div>
3141
<p>
32-
<a href="https://twitter.com/{{ site.project.twitter }}" class="twitter-follow-button" data-link-color="#0069D6" data-show-count="true">Follow @{{ site.project.twitter }}</a>
42+
<a
43+
href="https://twitter.com/{{ site.project.twitter }}"
44+
class="twitter-follow-button"
45+
data-link-color="#0069D6"
46+
data-show-count="true"
47+
>Follow @{{ site.project.twitter }}</a
48+
>
3349
</p>
3450
<p>
35-
3651
<a href="https://plus.google.com/+OBOOrg" rel="publisher">Google+</a>
3752
</p>
38-
<p>
39-
<ul class="buttons unstyled">
40-
<li><a href="https://github.com/{{ site.project.github.org }}" rel="me" class="social github" title="Go to github.com/{{ site.project.github.org }}" target="_blank"></a></li>
41-
<li><a href="http://www.twitter.com/{{ site.project.twitter }}" rel="me" class="social twitter" title="Go to twitter.com/{{ site.project.twitter }}" target="_blank"></a></li>
42-
<li><a href="https://github.com/{{ site.project.github.org }}/OBO/Feedback/issues/new" rel="me" class="social mail" title="Leave feedback for {{ site.project.name }}" target="_blank"></a></li>
43-
</ul>
44-
</p>
53+
<div>
54+
<ul class="buttons unstyled">
55+
<li>
56+
<a
57+
href="https://github.com/{{ site.project.github.org }}"
58+
rel="me"
59+
class="social github"
60+
title="Go to github.com/{{ site.project.github.org }}"
61+
target="_blank"
62+
></a>
63+
</li>
64+
<li>
65+
<a
66+
href="http://www.twitter.com/{{ site.project.twitter }}"
67+
rel="me"
68+
class="social twitter"
69+
title="Go to twitter.com/{{ site.project.twitter }}"
70+
target="_blank"
71+
></a>
72+
</li>
73+
<li>
74+
<a
75+
href="https://github.com/{{ site.project.github.org }}/OBO/Feedback/issues/new"
76+
rel="me"
77+
class="social mail"
78+
title="Leave feedback for {{ site.project.name }}"
79+
target="_blank"
80+
></a>
81+
</li>
82+
</ul>
83+
</div>

‎_includes/archive.html

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
<h2>Past Posts</h2>
22
<ul>
33
{% for post in site.posts %}
4-
<li>{{ post.date | date: "%Y - %B" }} <a href="{{ post.url }}">{{ post.title }}</a></li>
4+
<li>
5+
{{ post.date | date: "%Y - %B" }}
6+
<a href="{{ post.url }}">{{ post.title }}</a>
7+
</li>
58
{% endfor %}
6-
</ul>
9+
</ul>

‎_includes/docs_toc.md

+11-13
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,21 @@
1-
2-
31
[Operations Committee](/docs/OperationsCommittee.html)
42

5-
* [Mission Statement](/docs/MissionStatement.html)
6-
* [Membership](/docs/Membership.html)
7-
* [Meetings](/docs/CommitteeMeetings.html)
8-
* [Policy Decisions](/docs/OperationsCommitteePolicyDecisions.html)
9-
* [Mailing Lists](/docs/MailingLists.html)
10-
* [OBO Calendar](/docs/OBOCalendar.html)
3+
- [Mission Statement](/docs/MissionStatement.html)
4+
- [Membership](/docs/Membership.html)
5+
- [Meetings](/docs/CommitteeMeetings.html)
6+
- [Policy Decisions](/docs/OperationsCommitteePolicyDecisions.html)
7+
- [Mailing Lists](/docs/MailingLists.html)
8+
- [OBO Calendar](/docs/OBOCalendar.html)
119

1210
[Editorial Working Group](/docs/EditorialWG.html)
1311

14-
* [Review Process](/docs/ReviewProcessGuidelines.html)
15-
* [Review Criteria](/docs/ReviewCriteriaPolicies.html)
12+
- [Review Process](/docs/ReviewProcessGuidelines.html)
13+
- [Review Criteria](/docs/ReviewCriteriaPolicies.html)
1614

1715
[Technical Working Group](/docs/TechnicalWG.html)
1816

19-
* [PURL Requests](/docs/Policy_for_OBO_namespace_and_associated_PURL_requests.html)
20-
* [OBO PURL Configuration](/docs/OBOPURLDomain.html)
21-
* [Ontology tools and resources](/resources)
17+
- [PURL Requests](/docs/Policy_for_OBO_namespace_and_associated_PURL_requests.html)
18+
- [OBO PURL Configuration](/docs/OBOPURLDomain.html)
19+
- [Ontology tools and resources](/resources)
2220

2321
[Outreach Working Group](/docs/OutreachWG.html)

0 commit comments

Comments
 (0)