Skip to content

Commit

Permalink
Merge pull request #8 from roninjin10/11-03-feat_experimental_Generat…
Browse files Browse the repository at this point in the history
…e_docs

feat: Generate docs with typedoc
  • Loading branch information
lukasrosario authored Nov 8, 2023
2 parents fa1e9ed + 2df913d commit bf21aa3
Show file tree
Hide file tree
Showing 6 changed files with 738 additions and 13 deletions.
1 change: 1 addition & 0 deletions docs/reference/.nojekyll
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
49 changes: 49 additions & 0 deletions docs/reference/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
op-wagmi / [Exports](/reference/modules.md)

# OP Wagmi

Wagmi hooks for OP Stack Chains

<!-- Badge row 1 - status -->

[![GitHub contributors](https://img.shields.io/github/contributors/base-org/op-wagmi)](https://github.com/base-org/op-wagmi/graphs/contributors)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/w/base-org/op-wagmi)](https://github.com/base-org/op-wagmi/graphs/contributors)
[![GitHub Stars](https://img.shields.io/github/stars/base-org/op-wagmi.svg)](https://github.com/base-org/op-wagmi/stargazers)
![GitHub repo size](https://img.shields.io/github/repo-size/base-org/op-wagmi)
[![GitHub](https://img.shields.io/github/license/base-org/op-wagmi?color=blue)](https://github.com/base-org/op-wagmi/blob/main/LICENSE)

<!-- Badge row 2 - links and profiles -->

[![Website base.org](https://img.shields.io/website-up-down-green-red/https/base.org.svg)](https://base.org)
[![Blog](https://img.shields.io/badge/blog-up-green)](https://base.mirror.xyz/)
[![Docs](https://img.shields.io/badge/docs-up-green)](https://docs.base.org/)
[![Discord](https://img.shields.io/discord/1067165013397213286?label=discord)](https://base.org/discord)
[![Twitter BuildOnBase](https://img.shields.io/twitter/follow/BuildOnBase?style=social)](https://twitter.com/BuildOnBase)

<!-- Badge row 3 - detailed status -->

[![GitHub pull requests by-label](https://img.shields.io/github/issues-pr-raw/base-org/op-wagmi)](https://github.com/base-org/op-wagmi/pulls)
[![GitHub Issues](https://img.shields.io/github/issues-raw/base-org/op-wagmi.svg)](https://github.com/base-org/op-wagmi/issues)

## Features

- Simplifies cross L1 & L2 interactions
- TypeScript ready
- Test suite running against [forked](https://ethereum.org/en/glossary/#fork) Ethereum network

## Overview

## Community

## Contributing

If you're interested in contributing, please read the [contributing docs](CONTRIBUTING.md) **before submitting a pull request**.

## Authors

- [@zencephalon](https://github.com/zencephalon) (zencephalon.eth, [Twitter](https://twitter.com/zencephalon))
- [@lukasrosario](https://github.com/lukasrosario) (lsr.eth, [Twitter](https://twitter.com/0xlsr))

## License

[Apache V2](LICENSE) License
Loading

0 comments on commit bf21aa3

Please sign in to comment.