Skip to content
This repository was archived by the owner on Oct 4, 2020. It is now read-only.

Commit 2955b94

Browse files
committed
Use pursuit for docs
1 parent b4946c2 commit 2955b94

28 files changed

+14
-3004
lines changed

.travis.yml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
language: node_js
22
sudo: false
33
node_js:
4-
- 0.10
4+
- 4
55
env:
66
- PATH=$HOME/purescript:$PATH
77
install:
@@ -13,3 +13,11 @@ install:
1313
- npm install && bower install
1414
script:
1515
- gulp
16+
after_success:
17+
- >-
18+
test $TRAVIS_TAG &&
19+
psc-publish > .pursuit.json &&
20+
curl -X POST http://pursuit.purescript.org/packages \
21+
-d @.pursuit.json \
22+
-H 'Accept: application/json' \
23+
-H "Authorization: token ${GITHUB_TOKEN}"

README.md

Lines changed: 2 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -31,33 +31,8 @@ Interfaces from DOM4 are grouped under `DOM.Node` and interfaces from HTML5 are
3131

3232
In each submodule there is a `.Types` which should enumerate `foreign` data types for the interfaces within and the coercions and `Foreign`-reading functions that go with them. After that each interface should have its own submodule - so for example, `Element` is provided in `DOM.Node.Types` and the functions from the `Element` API are defined in `DOM.Node.Element`. Enumeration types such as `NodeType` also get their own modules, such as `DOM.Node.NodeType`.
3333

34+
Module documentation is published on Pursuit: http://pursuit.purescript.org/packages/purescript-dom
35+
3436
## Non-standards compliant interfaces
3537

3638
Currently we're choosing not to implement deprecated or non-standard interfaces even if they are commonly available. The `innerHTML` property of `Element` and `keyCode`/`charCode` of `KeyboardEvent` being examples of this. Ideally this module will only provide types and functions that "everyone" can agree on. This also means new parts of the specifications that are currently not widely available may also be omitted for the time being, however this only applies to the API implementation, types for new interfaces will be included as needed.
37-
38-
## Module documentation
39-
40-
- [DOM](docs/DOM.md)
41-
- [DOM.Event.Event](docs/DOM/Event/Event.md)
42-
- [DOM.Event.EventPhase](docs/DOM/Event/EventPhase.md)
43-
- [DOM.Event.EventTarget](docs/DOM/Event/EventTarget.md)
44-
- [DOM.Event.EventTypes](docs/DOM/Event/EventTypes.md)
45-
- [DOM.Event.Types](docs/DOM/Event/Types.md)
46-
- [DOM.File.Types](docs/DOM/File/Types.md)
47-
- [DOM.HTML](docs/DOM/HTML.md)
48-
- [DOM.HTML.Document](docs/DOM/HTML/Document.md)
49-
- [DOM.HTML.Types](docs/DOM/HTML/Types.md)
50-
- [DOM.HTML.Window](docs/DOM/HTML/Window.md)
51-
- [DOM.Node.ChildNode](docs/DOM/Node/ChildNode.md)
52-
- [DOM.Node.Document](docs/DOM/Node/Document.md)
53-
- [DOM.Node.DocumentType](docs/DOM/Node/DocumentType.md)
54-
- [DOM.Node.Element](docs/DOM/Node/Element.md)
55-
- [DOM.Node.HTMLCollection](docs/DOM/Node/HTMLCollection.md)
56-
- [DOM.Node.Node](docs/DOM/Node/Node.md)
57-
- [DOM.Node.NodeList](docs/DOM/Node/NodeList.md)
58-
- [DOM.Node.NodeType](docs/DOM/Node/NodeType.md)
59-
- [DOM.Node.NonDocumentTypeChildNode](docs/DOM/Node/NonDocumentTypeChildNode.md)
60-
- [DOM.Node.NonElementParentNode](docs/DOM/Node/NonElementParentNode.md)
61-
- [DOM.Node.ParentNode](docs/DOM/Node/ParentNode.md)
62-
- [DOM.Node.Types](docs/DOM/Node/Types.md)
63-
- [DOM.XHR.Types](docs/DOM/XHR/Types.md)

docs/DOM.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/DOM/Event/Event.md

Lines changed: 0 additions & 103 deletions
This file was deleted.

docs/DOM/Event/EventPhase.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/DOM/Event/EventTarget.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

0 commit comments

Comments
 (0)