mirror of
https://github.com/flame-engine/flame.git
synced 2025-10-29 16:05:47 +08:00
docs: Added links to API and Examples in doc sidebar (#1997)
Based on a brief discussion with Spydon, this adds two links in the docs sidebar to API docs on pub.dev as well as a link to the flame examples.
This commit is contained in:
@ -35,7 +35,7 @@ Put the pub package as your dependency by putting the following in your `pubspec
|
||||
|
||||
```yaml
|
||||
dependencies:
|
||||
flame: <VERSION>
|
||||
flame: --VERSION--
|
||||
```
|
||||
|
||||
The latest version can be found on [pub.dev](https://pub.dev/packages/flame/install).
|
||||
|
||||
@ -85,7 +85,6 @@ class TitleCollector(docutils.nodes.SparseNodeVisitor):
|
||||
self.level -= 1
|
||||
|
||||
|
||||
|
||||
def get_local_toc(document):
|
||||
if not document:
|
||||
return ""
|
||||
|
||||
@ -85,8 +85,7 @@
|
||||
|
||||
<a href="{{pathto('index')}}" class="logo_image">
|
||||
<img src="{{pathto('_static/logo_flame.png', 1)}}">
|
||||
</a>
|
||||
|
||||
</a>
|
||||
<div class="highlight-box" role="alert" style="display:none">
|
||||
<div>
|
||||
<div class="title">highlighted:</div>
|
||||
|
||||
@ -7,7 +7,7 @@ list in your `pubspec.yaml` file:
|
||||
|
||||
```yaml
|
||||
dependencies:
|
||||
flame_audio: <VERSION>
|
||||
flame_audio: VERSION
|
||||
```
|
||||
|
||||
The latest version can be found on [pub.dev](https://pub.dev/packages/flame_audio/install).
|
||||
|
||||
@ -10,4 +10,5 @@ flame_forge2d <flame_forge2d/flame_forge2d.md>
|
||||
Tutorials <tutorials/tutorials.md>
|
||||
Other Modules <other_modules/other_modules.md>
|
||||
Development <development/development.md>
|
||||
Resources <resources/resources.md>
|
||||
```
|
||||
|
||||
6
doc/resources/resources.md
Normal file
6
doc/resources/resources.md
Normal file
@ -0,0 +1,6 @@
|
||||
# Resources
|
||||
|
||||
```{toctree}
|
||||
Flame API <https://pub.dev/documentation/flame/--VERSION--/>
|
||||
Flame Examples <https://examples.flame-engine.org/#/>
|
||||
```
|
||||
Reference in New Issue
Block a user