Skip to content

Commit 7249103

Browse files
5ZYSZ3Kjsamr
authored andcommitted
chore: adjust docs with the new page
1 parent c6e280b commit 7249103

11 files changed

Lines changed: 56 additions & 76 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,8 @@ body:
88
description: |
99
A good amount of bug reports are actually feature requests. To help you with that, read and check all the boxes to make sure you really need to fill the full template. If you can't check those two boxes, this is a feature request, not a bug. Fill a feature request here: https://native-html.canny.io/features
1010
options:
11-
- label: "My issue does not look like “The HTML attribute 'xxx' is ignored” (unless
12-
we claim support for it)"
13-
required: true
11+
- label: "My issue does not look like “The HTML attribute 'xxx' is ignored” (unlesswe claim support for it)"
12+
- required: true
1413
- label: "My issue does not look like “The HTML element `<yyy>` is not rendered”"
1514
required: true
1615
validations:
@@ -44,8 +43,8 @@ body:
4443
- type: textarea
4544
attributes:
4645
label: "RNRH Version"
47-
placeholder: "Type which version of react-native-render-html you are using."
48-
validations:
46+
placeholder: "Type which version of @native-html/render you are using."
47+
validations:
4948
required: true
5049
- type: checkboxes
5150
attributes:
@@ -76,7 +75,7 @@ body:
7675
label: Minimal, Reproducible Example
7776
description: |
7877
[*What is a Minimal, Reproducible Example (MRE)?*](https://stackoverflow.com/help/minimal-reproducible-example). Provide either a link to an expo snack, git repository, or a code block. You can fork [**our Snack template**](https://snack.expo.dev/@jsamr/rnrhtml-template) to gain time (follow instructions from the README in this snack)! The MRE **must be self-contained**, and **HTML inlined** unless strictly necessary (e.g., a bug with remote HTML). Also note:
79-
- If your issue is related to operations such as dependency resolution or testing, **you must** provide a MRE in the form of a git repository.
78+
- If your issue is related to operations such as dependency resolution or testing, **you must** provide a MRE in the form of a git repository.
8079
- If and only if you provide a regression test in lieu of a MRE, you can reference the related PR instead.
8180
placeholder: "https://snack.expo.dev/@jsamr/rnrhtml-template"
8281
validations:
@@ -86,4 +85,4 @@ body:
8685
label: Additional Notes
8786
description: "Any extra information that can help with the resolution. If other libraries are involved in the MRE, note their versions here."
8887
validations:
89-
required: false
88+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ contact_links:
44
url: https://native-html.canny.io/features
55
about: A page where all feature requests are handled.
66
- name: 🆘 Getting Help
7-
url: https://github.com/meliorence/react-native-render-html/blob/master/HELP.adoc
7+
url: https://github.com/native-html/render/blob/main/HELP.adoc
88
about: A resource which describes all the steps you should go through when you're facing an issue with this library.
99
- name: 🌐 Official Website
10-
url: https://meliorence.github.io/react-native-render-html/
11-
about: The official website with plenty of guides, blog posts and documentation!
10+
url: https://native-html.github.io/render/
11+
about: The official website with plenty of guides, blog posts and documentation!

HELP.adoc

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ I am using `@native-html/render` and I am witnessing a failure such as:
3737
[sidebar]
3838
.__Recommendations__
3939
--
40-
1. Read the https://meliorence.github.io/react-native-render-html/docs/faq[FAQ].
40+
1. Read the https://native-html.github.io/render/docs/faq[FAQ].
4141
2. Take a look at
42-
https://stackoverflow.com/questions/tagged/react-native-render-html for similar
42+
https://stackoverflow.com/questions/tagged/native-html-render or https://stackoverflow.com/questions/tagged/react-native-render-html for similar
4343
questions.
4444
3. Take a look at
45-
https://github.com/meliorence/react-native-render-html/issues[our issue tracker]
45+
https://github.com/native-html/render/issues[our issue tracker]
4646
for similar questions.
4747
4. If you still don't have a solution, you can choose one or more:
4848
+
@@ -85,14 +85,14 @@ B. Select "Check by text input"
8585
C. Paste your snippet in the body of the document.
8686
D. Press "Check"
8787
2. Make sure your issue isn't covered
88-
https://meliorence.github.io/react-native-render-html/docs/intro[by
88+
https://native-html.github.io/render/docs/intro[by
8989
the docs].
90-
3. Read the https://meliorence.github.io/react-native-render-html/docs/faq[FAQ].
90+
3. Read the https://native-html.github.io/render/docs/faq[FAQ].
9191
4. Take a look at
92-
https://stackoverflow.com/questions/tagged/react-native-render-html for similar
92+
https://stackoverflow.com/questions/tagged/native-html-render or https://stackoverflow.com/questions/tagged/react-native-render-html for similar
9393
questions.
9494
5. Take a look at
95-
https://github.com/meliorence/react-native-render-html/issues[our issue tracker]
95+
https://github.com/native-html/render/issues[our issue tracker]
9696
for similar questions.
9797
6. If you still don't have a solution, you can choose one or more:
9898
+
@@ -109,19 +109,19 @@ report anyway.
109109
.__Recommendations__
110110
--
111111
1. Make sure the feature isn't covered
112-
https://meliorence.github.io/react-native-render-html/docs/intro[by
112+
https://native-html.github.io/render/docs/intro[by
113113
the docs].
114-
2. Read the https://meliorence.github.io/react-native-render-html/docs/faq[FAQ].
114+
2. Read the https://native-html.github.io/render/docs/faq[FAQ].
115115
3. Take a look at
116-
https://stackoverflow.com/questions/tagged/react-native-render-html for similar
116+
https://stackoverflow.com/questions/tagged/native-html-render or https://stackoverflow.com/questions/tagged/react-native-render-html for similar
117117
questions.
118118
4. Take a look at
119-
https://github.com/meliorence/react-native-render-html/issues[our issue tracker]
119+
https://github.com/native-html/render/issues[our issue tracker]
120120
for similar questions.
121121
5. If you still don't have an answer, you can choose one or more:
122122
+
123123
A. https://stackoverflow.com/questions/ask[Opening a StackOverflow post] with the
124-
`react-native-render-html` tag.
124+
`@native-html/render` tag.
125125
B. Submitting a <<CONTRIBUTING.adoc#features,Feature Request>>.
126126
C. Going to https://discord.gg/dbEMMJM[our Discord #support channel].
127127
--
@@ -133,9 +133,9 @@ C. Going to https://discord.gg/dbEMMJM[our Discord #support channel].
133133
.__Recommendations__
134134
--
135135
1. Carefully
136-
https://meliorence.github.io/react-native-render-html/docs/intro[read
136+
https://native-html.github.io/render/docs/intro[read
137137
the docs].
138-
2. Read the https://meliorence.github.io/react-native-render-html/docs/faq[FAQ].
138+
2. Read the https://native-html.github.io/render/docs/faq[FAQ].
139139
3. If you still find difficult to use this feature, then we are lacking good
140140
documentation, and we should fix it. Go to https://discord.gg/dbEMMJM[our
141141
Discord #support channel] and we will help you out.

README.md

Lines changed: 18 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -12,37 +12,31 @@
1212
/></a>
1313
</div>
1414
<div align="center">
15-
<a href="https://www.npmjs.com/package/react-native-render-html"
15+
<a href="https://www.npmjs.com/package/@native-html/render"
1616
><img
17-
src="https://img.shields.io/npm/v/react-native-render-html/latest"
17+
src="https://img.shields.io/npm/v/@native-html/render/latest"
1818
alt="npm"
1919
/></a>
20-
<a href="https://www.npmjs.com/package/react-native-render-html"
20+
<a href="https://www.npmjs.com/package/@native-html/render"
2121
><img
22-
src="https://img.shields.io/npm/v/react-native-render-html/next"
22+
src="https://img.shields.io/npm/v/@native-html/render/next"
2323
alt="npm"
2424
/></a>
25-
<a href="https://www.npmjs.com/package/react-native-render-html"
25+
<a href="https://www.npmjs.com/package/@native-html/render"
2626
><img
27-
src="https://img.shields.io/npm/dm/react-native-render-html.svg?colorB=007ec6"
27+
src="https://img.shields.io/npm/dm/@native-html/render.svg?colorB=007ec6"
2828
alt="npm"
2929
/></a>
3030
</div>
3131
<div align="center">
32-
<a href="https://codecov.io/gh/meliorence/react-native-render-html"
32+
<a href="https://codecov.io/gh/native-html/render"
3333
><img
34-
src="https://img.shields.io/codecov/c/gh/meliorence/react-native-render-html"
34+
src="https://img.shields.io/codecov/c/gh/native-html/render"
3535
alt=""
3636
/></a>
37-
<a
38-
href="https://github.com/meliorence/react-native-render-html/actions?query=branch%3Amaster+workflow%3ACI"
37+
<a href="https://github.com/native-html/render/issues"
3938
><img
40-
src="https://github.com/meliorence/react-native-render-html/workflows/CI/badge.svg?branch=master"
41-
alt=""
42-
/></a>
43-
<a href="https://github.com/meliorence/react-native-render-html/issues"
44-
><img
45-
src="https://img.shields.io/github/issues/meliorence/react-native-render-html.svg"
39+
src="https://img.shields.io/github/issues/native-html/render.svg"
4640
alt="github issues"
4741
/></a>
4842
<a href="https://semver.org/spec/v2.0.0.html"
@@ -55,17 +49,11 @@
5549
src="https://img.shields.io/discord/736906960041148476?label=discord"
5650
alt=""
5751
/></a>
58-
<a
59-
href="https://openbase.com/js/react-native-render-html?utm_source=embedded&amp;utm_medium=badge&amp;utm_campaign=rate-badge"
60-
><img
61-
src="https://badges.openbase.com/js/rating/react-native-render-html.svg"
62-
alt="Rate on Openbase"
63-
/></a>
6452
</div>
6553
</p>
6654
<br/>
6755
<p align="center">
68-
<a href="https://meliorence.github.io/react-native-render-html/"><img width="124" height="124" src="https://github.com/meliorence/react-native-render-html/raw/master/assets/logo.svg"></a>
56+
<a href="https://native-html.github.io/render/"><img width="124" height="124" src="https://github.com/native-html/render/raw/main/assets/logo.svg"></a>
6957
</p>
7058
<h1 align="center">@native-html/render</h1>
7159
<p align="center">
@@ -75,28 +63,25 @@
7563
An iOS/Android pure javascript react-native component that renders your HTML into 100% native views.
7664
</p>
7765
<p align="center">
78-
<a href="https://meliorence.github.io/react-native-render-html/blog/2021/06/27/create-blog-app-rnrh-I"><img width="320" height="744" src="https://github.com/meliorence/react-native-render-html/raw/master/assets/demo.gif"></a>
66+
<a href="https://native-html.github.io/render/blog/2021/06/27/create-blog-app-rnrh-I"><img width="320" height="744" src="https://github.com/native-html/render/raw/main/assets/demo.gif"></a>
7967
</p>
8068

8169
### 🗃️ Releases
8270

8371
**The Foundry (v6) release is finally stable, and is now-on the recommended
8472
version.** [Check out **the announcement blog post** in our brand new
85-
website](https://meliorence.github.io/react-native-render-html/blog/2021/06/07/foundry-announcement).
73+
website](https://native-html.github.io/render/blog/2021/06/07/foundry-announcement).
8674
We also have a [**migration
87-
guide**](https://meliorence.github.io/react-native-render-html/docs/migration-guide)
75+
guide**](https://native-html.github.io/render/docs/migration-guide)
8876
for those who are coming from v5 and below.
8977

90-
> :warning: **You are on the master branch which is home for the latest development.**
78+
> :warning: **You are on the main branch which is home for the latest development.**
9179
> Check the table bellow to get documentation for your exact
9280
> version.
9381
9482
| Minor | Branch | Documentation | Latest |
9583
| ----- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
96-
| next | master | - | [![npm](https://img.shields.io/npm/v/react-native-render-html/next)](#) |
97-
| 6.3 | [release/6.3](https://github.com/meliorence/react-native-render-html/tree/release/6.3) | [Official Website](https://meliorence.github.io/react-native-render-html/) | [![npm](https://img.shields.io/npm/v/react-native-render-html/release/6.3)](#) |
98-
| 5.1   | [release/5.1](https://github.com/meliorence/react-native-render-html/tree/release/5.1)   | [release/5.1/README.md](https://github.com/meliorence/react-native-render-html/blob/release/5.1/README.md) | [![npm](https://img.shields.io/npm/v/react-native-render-html/release/5.1)](#) |
99-
| 4.2   | [release/4.2](https://github.com/meliorence/react-native-render-html/tree/release/4.2)   | [release/4.2/README.md](https://github.com/meliorence/react-native-render-html/blob/release/4.2/README.md) | [![npm](https://img.shields.io/npm/v/react-native-render-html/release/4.2)](#) |
84+
| next | main | - | [![npm](https://img.shields.io/npm/v/@native-html/render/next)](#) |
10085

10186
<a name="prereleases"></a>
10287

@@ -137,11 +122,11 @@ export default function App() {
137122

138123
## :blue_book: Documentation
139124

140-
See our [official website](https://meliorence.github.io/react-native-render-html/) and [the official Discovery App](https://expo.io/@jsamr/react-native-render-html-discovery).
125+
See our [official website](https://native-html.github.io/render/)
141126

142127
## :iphone: Example
143128

144-
You like to learn by example? We have a tutorial from which the demo GIF has been extracted: [A WebView-free Blog App with React Native Render HTML](https://meliorence.github.io/react-native-render-html/blog/2021/06/27/create-blog-app-rnrh-I).
129+
You like to learn by example? We have a tutorial from which the demo GIF has been extracted: [A WebView-free Blog App with Native HTML](https://native-html.github.io/render/blog/2021/06/27/create-blog-app-rnrh-I).
145130

146131
## :notebook: Changelog
147132

apps/discovery/app.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ module.exports = {
33
name: 'RNRH Discovery',
44
slug: '@native-html/render-discovery',
55
description:
6-
'An App to discover React Native Render HTML features and API!',
6+
'An App to discover Native HTML features and API!',
77
version: require('./version').demo,
88
primaryColor: '#6767e2',
99
orientation: 'default',

apps/discovery/src/navigation/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import RootNavigator from './RootNavigator';
55
import { useTheme } from '../theme/ThemeProvider';
66

77
const linking = {
8-
prefixes: ['https://meliorence.github.io/react-native-render-html']
8+
prefixes: ['https://native-html.github.io/render']
99
};
1010

1111
export default function Navigation() {

apps/website/docusaurus.config.ts

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ const plugins: any[] = [
7272
];
7373

7474
const config: Config = {
75-
title: 'React Native Render HTML',
75+
title: 'Native HTML',
7676
tagline:
7777
'The hackable, full-featured Open Source HTML rendering solution for React Native.',
7878
url: WEBSITE_ROOT,
@@ -145,12 +145,12 @@ const config: Config = {
145145
position: 'left'
146146
},
147147
{
148-
to: `https://github.com/meliorence/react-native-render-html/releases/tag/v${version}`,
148+
to: `https://github.com/native-html/render/releases/tag/v${version}`,
149149
label: `v${version}`,
150150
position: 'right'
151151
},
152152
{
153-
href: 'https://github.com/meliorence/react-native-render-html',
153+
href: 'https://github.com/native-html/render',
154154
position: 'right',
155155
className: 'header-github-link',
156156
'aria-label': 'GitHub repository'
@@ -223,11 +223,11 @@ const config: Config = {
223223
title: 'Community',
224224
items: [
225225
{
226-
to: 'https://github.com/meliorence/react-native-render-html/blob/master/HELP.adoc',
226+
to: 'https://github.com/native-html/render/blob/main/HELP.adoc',
227227
label: 'Help'
228228
},
229229
{
230-
to: 'https://github.com/meliorence/react-native-render-html/blob/master/CONTRIBUTING.adoc',
230+
to: 'https://github.com/native-html/render/blob/main/CONTRIBUTING.adoc',
231231
label: 'Contributing'
232232
},
233233
{
@@ -236,7 +236,7 @@ const config: Config = {
236236
},
237237
{
238238
label: 'Stack Overflow',
239-
href: 'https://stackoverflow.com/questions/tagged/react-native-render-html'
239+
href: 'https://stackoverflow.com/questions/tagged/native-html-render'
240240
},
241241
{
242242
label: 'Discord',
@@ -253,15 +253,11 @@ const config: Config = {
253253
},
254254
{
255255
label: 'GitHub',
256-
href: 'https://github.com/meliorence/react-native-render-html'
256+
href: 'https://github.com/native-html/render'
257257
},
258258
{
259259
label: 'Twitter',
260260
href: 'https://twitter.com/jsamrn?ref_src=twsrc%5Etfw'
261-
},
262-
{
263-
label: 'Rate this library',
264-
href: 'https://openbase.com/js/react-native-render-html?utm_source=embedded&utm_medium=badge&utm_campaign=rate-badge'
265261
}
266262
]
267263
}
@@ -283,7 +279,7 @@ const config: Config = {
283279
showReadingTime: true,
284280
feedOptions: {
285281
type: 'all',
286-
title: 'React Native Render HTML Official Blog',
282+
title: 'Native HTML Official Blog',
287283
copyright: `Copyright © ${new Date().getFullYear()} Meliorence, Inc. and Jules Sam. Randolph`
288284
}
289285
},

apps/website/src/components/Badges.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ export default function Badges() {
77
<div className={classes.stats}>
88
<TwitterFollow className={classes.badge} />
99
<iframe
10-
src="https://ghbtns.com/github-btn.html?user=meliorence&repo=react-native-render-html&type=star&count=true&size=small"
10+
src="https://ghbtns.com/github-btn.html?user=native-html&repo=render&type=star&count=true&size=small"
1111
frameBorder="0"
1212
scrolling="0"
1313
width="92"

apps/website/src/components/HomepageHeader.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export default function HomepageHeader() {
2424
<header className={classes.root}>
2525
<div className={classes.rootOverlay} />
2626
<div className={clsx(classes.title, 'margin-bottom--md')}>
27-
<h1 className={clsx('hero__title')}>React Native Render HTML</h1>
27+
<h1 className={clsx('hero__title')}>Native HTML</h1>
2828
<p className={clsx('hero__subtitle', classes.subtitle)}>
2929
Give a <strong>genuine native</strong> feeling to your HTML content.
3030
</p>
@@ -63,7 +63,7 @@ export default function HomepageHeader() {
6363
<Screenshot
6464
url={showcaseImgJpeg}
6565
webpUrl={showcaseImgWebp}
66-
alt="Showcase of a component rendered with React Native Render HTML."
66+
alt="Showcase of a component rendered with Native HTML."
6767
scale={1}
6868
/>
6969
<div className={classes.screenshotOverlay} />

apps/website/src/typeui/HeaderTypeBox.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ export default function HeaderTypeBox({
8282
target="_blank"
8383
rel="noopener"
8484
className={classes.sourceBox}
85-
href={`https://github.com/meliorence/react-native-render-html/tree/v${version}/${source.fileName}#L${source.line}`}>
85+
href={`https://github.com/native-html/render/tree/v${version}/${source.fileName}#L${source.line}`}>
8686
{source.fileName}
8787
</a>
8888
)}

0 commit comments

Comments
 (0)