Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: remove dev docs from IPFS Companion section #203

Merged
merged 1 commit into from
May 8, 2020
Merged

fix: remove dev docs from IPFS Companion section #203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions docs/.vuepress/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,11 +287,8 @@ module.exports = {
sidebarDepth: 1,
collapsable: false,
children: [
'how-to/companion-android-firefox',
'how-to/companion-developer-notes',
'how-to/companion-node-types',
'how-to/dnslink-companion',
'how-to/companion-localization',
'how-to/companion-window-ipfs',
'/how-to/companion-x-ipfs-path-header'
]
Expand Down
65 changes: 0 additions & 65 deletions docs/how-to/companion-android-firefox.md
View file
Open in desktop

This file was deleted.

112 changes: 0 additions & 112 deletions docs/how-to/companion-developer-notes.md
View file
Open in desktop

This file was deleted.

43 changes: 0 additions & 43 deletions docs/how-to/companion-localization.md
View file
Open in desktop

This file was deleted.

6 changes: 5 additions & 1 deletion docs/how-to/companion-window-ipfs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
---
title: Using Window.IFPS
title: Using `window.ipfs`
description: Learn about exposing IPFS API in IPFS Companion via "window.ipfs".
---

# Using `window.ipfs` in IPFS Companion

Learn about exposing IPFS API in IPFS Companion via "window.ipfs".

::: danger

## `window.ipfs` is currently disabled

IPFS Companion 2.11 stopped injecting `window.ipfs`. It will be restored after the [move to JS API with async await and async iterables](https://github.com/ipfs-shipyard/ipfs-companion/issues/843), with a likely ETA of Q3 2020. This page is provided for reference only.

:::

### Disclaimer

There is a substantial amount of [ongoing work for this interface](https://github.com/ipfs-shipyard/ipfs-companion/issues/589). Want to help with shaping it? See [#589](https://github.com/ipfs-shipyard/ipfs-companion/issues/589) and [issues with the `area/window-ipfs` label](https://github.com/ipfs-shipyard/ipfs-companion/labels/area%2Fwindow-ipfs).
Expand Down