Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
O
openzeppelin-contracts-upgradeable
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
俞永鹏
openzeppelin-contracts-upgradeable
Commits
18d7e24a
Commit
18d7e24a
authored
Aug 16, 2019
by
Francisco Giordano
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
rename docsite script to docs and update docs setup description
parent
29e20ff9
Show whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
9 additions
and
12 deletions
+9
-12
DOCUMENTATION.md
DOCUMENTATION.md
+6
-9
netlify.toml
netlify.toml
+1
-1
package.json
package.json
+1
-1
docs.sh
scripts/docs.sh
+1
-1
No files found.
DOCUMENTATION.md
View file @
18d7e24a
We're building an improved documentation website. It's still in development and
Documentation is hosted at https://docs.openzeppelin.com/contracts.
contributions will be really appreciated.
All of the content for the site is in this repository. The guides are in the
All of the content for the site is in this repository. The guides are in the
[
docs
](
/docs
)
directory, and the API Reference is extracted from comments in
[
docs
](
/docs
)
directory, and the API Reference is extracted from comments in
...
@@ -9,11 +8,9 @@ repository you should be contributing to.
...
@@ -9,11 +8,9 @@ repository you should be contributing to.
[
`solidity-docgen`
](
https://github.com/OpenZeppelin/solidity-docgen
)
is the
[
`solidity-docgen`
](
https://github.com/OpenZeppelin/solidity-docgen
)
is the
program that extracts the API Reference from source code.
program that extracts the API Reference from source code.
The
[
`
openzeppelin-docsite`
](
https://github.com/OpenZeppelin/openzeppelin-docsite
)
The
[
`
docs.openzeppelin.com`
](
https://github.com/OpenZeppelin/docs.openzeppelin.com
)
repository hosts the configuration for
Docusaurus, the static site generator
repository hosts the configuration for
the entire site, which includes
that we use
.
documetation for all of the OpenZeppelin projects
.
To run the docsite locally you should run
`npm run docsite start`
on this
To run the docs locally you should run
`npm run docs start`
on this
repository. This will live reload as the guides are edited, but not with
repository.
changes to the source code comments, for that you need to restart the server.
This should be improved eventually (contributions welcome!).
netlify.toml
View file @
18d7e24a
[build]
[build]
command
=
"npm run docs
ite
build"
command
=
"npm run docs build"
publish
=
"openzeppelin-docs/build/site"
publish
=
"openzeppelin-docs/build/site"
package.json
View file @
18d7e24a
...
@@ -13,7 +13,7 @@
...
@@ -13,7 +13,7 @@
"compile"
:
"scripts/compile.sh"
,
"compile"
:
"scripts/compile.sh"
,
"console"
:
"truffle console"
,
"console"
:
"truffle console"
,
"coverage"
:
"scripts/coverage.sh"
,
"coverage"
:
"scripts/coverage.sh"
,
"docs
ite"
:
"scripts/docsite
.sh"
,
"docs
"
:
"scripts/docs
.sh"
,
"prepare-docs"
:
"scripts/prepare-docs.sh"
,
"prepare-docs"
:
"scripts/prepare-docs.sh"
,
"lint"
:
"npm run lint:js && npm run lint:sol"
,
"lint"
:
"npm run lint:js && npm run lint:sol"
,
"lint:fix"
:
"npm run lint:js:fix"
,
"lint:fix"
:
"npm run lint:js:fix"
,
...
...
scripts/docs
ite
.sh
→
scripts/docs.sh
View file @
18d7e24a
#!/usr/bin/env bash
#!/usr/bin/env bash
if
[
"
$1
"
!=
"build"
-a
"
$1
"
!=
"start"
]
;
then
if
[
"
$1
"
!=
"build"
-a
"
$1
"
!=
"start"
]
;
then
echo
"usage: npm run docs
ite
(build|start)"
>
&2
echo
"usage: npm run docs (build|start)"
>
&2
exit
1
exit
1
fi
fi
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment