retypeapp-win-x64 1.11.2 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/README.md +80 -0
- package/bin/retype.exe +0 -0
- package/package.json +4 -1
package/LICENSE
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Retype Software License Agreement
|
|
2
2
|
|
|
3
|
-
Version 1.
|
|
3
|
+
Version 2.1.0
|
|
4
4
|
|
|
5
5
|
THIS DOCUMENT IS A LEGAL AGREEMENT (the "License Agreement") BETWEEN OBJECT.NET, INC. ("We," "Us")
|
|
6
6
|
AND YOU OR THE ORGANIZATION ON WHOSE BEHALF YOU ARE UNDERTAKING THE LICENSE DESCRIBED BELOW ("You",
|
package/README.md
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# Retype - Write anything
|
|
2
|
+
|
|
3
|
+
[Retype](https://retype.com/) is an :sparkles: ultra-high-performance :sparkles: generator that builds a website based on simple text files. Focus on your writing while Retype builds the rest.
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
No coding is required and just one Markdown file, such as a [`README.md`](https://www.makeareadme.com/), will get you started.
|
|
8
|
+
|
|
9
|
+
> The [retype.com](https://retype.com/) website was generated using Retype.
|
|
10
|
+
|
|
11
|
+
A new Retype powered website can be up and running within seconds once Retype is installed, which itself takes only a few seconds. :+1:
|
|
12
|
+
|
|
13
|
+
## Quick start
|
|
14
|
+
|
|
15
|
+
You [install](https://retype.com/guides/getting-started/) Retype using [`npm`](https://www.npmjs.com/get-npm), [`yarn`](https://classic.yarnpkg.com/en/docs/install/), or the [`dotnet`](https://dotnet.microsoft.com/download/dotnet-core) CLI.
|
|
16
|
+
|
|
17
|
+
From your command line, navigate to a folder location where you have one or more Markdown `.md` files, such as a GitHub or GitLab project.
|
|
18
|
+
|
|
19
|
+
Next, choose one of the following tools to first install `retypeapp` and then start Retype by using the [`retype watch`](https://retype.com/guides/cli/#retype-watch) command:
|
|
20
|
+
|
|
21
|
+
### NPM
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
npm install retypeapp-win-x64 --global
|
|
25
|
+
retype watch
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Yarn
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
yarn global add retypeapp-win-x64
|
|
32
|
+
retype watch
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### dotnet
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
dotnet tool install retypeapp --global
|
|
39
|
+
retype watch
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
That's it! Your new Retype website should be up and running.
|
|
43
|
+
|
|
44
|
+
## Features
|
|
45
|
+
|
|
46
|
+
#### :tada: It just works
|
|
47
|
+
|
|
48
|
+
Retype has been built to be easy to use and should _"just work"_ out-of-the-box without any special configuration or troublesome setup.
|
|
49
|
+
|
|
50
|
+
#### :zap: Lightning fast
|
|
51
|
+
|
|
52
|
+
Don't blink. Retype was built for speed.
|
|
53
|
+
|
|
54
|
+
#### :white_check_mark: Easy install
|
|
55
|
+
|
|
56
|
+
[Installation](https://retype.com/guides/getting-started/) takes only a few seconds. Then you need at least one Markdown `.md` file which Retype will start building a new website from.
|
|
57
|
+
|
|
58
|
+
#### :muscle: Powerful
|
|
59
|
+
|
|
60
|
+
Project level [configuration](https://retype.com/configuration/project/) using `retype.yml` unlocks many more Retype features and customization.
|
|
61
|
+
|
|
62
|
+
#### :pencil2: Simple formatting
|
|
63
|
+
|
|
64
|
+
Pages are [formatted](https://retype.com/guides/formatting/) using Markdown syntax and Retype [components](https://retype.com/components/). Page level [configuration](https://retype.com/configuration/page/) is available, such as customizing the navigation [`label`](https://retype.com/configuration/page/#label) or [`description`](https://retype.com/configuration/page/#description) used by search engines.
|
|
65
|
+
|
|
66
|
+
#### :arrows_clockwise: Live reload
|
|
67
|
+
|
|
68
|
+
If a change is detected, such as editing and saving an `.md` file, your Retype website will be updated almost instantly within the browser. After running [`retype watch`](https://retype.com/guides/cli/#retype-watch), edit any `.md` file and see your changes appear in the browser almost instantly.
|
|
69
|
+
|
|
70
|
+
#### :computer: Host anywhere
|
|
71
|
+
|
|
72
|
+
Retype generates a basic HTML website that you can self-host on any web hosting service, such as [GitHub](https://docs.github.com/en/pages/quickstart) or [GitLab](https://docs.gitlab.com/ee/user/project/pages/). No special server-side software or external dependencies are required. You can host your Retype site as a public website or as a private website inside your organization.
|
|
73
|
+
|
|
74
|
+
## Support
|
|
75
|
+
|
|
76
|
+
Technical support questions are best asked in the [Discussions](https://github.com/retypeapp/retype/discussions). The discussions are monitored 24 hours a day and we will do our best to assist.
|
|
77
|
+
|
|
78
|
+
If you find a defect or would like to submit a feature request, please create an [Issue](https://github.com/retypeapp/retype/issues) and we will investigate right away.
|
|
79
|
+
|
|
80
|
+
Do you have a general inquiry? Please feel free to contact us at hello@object.net.
|
package/bin/retype.exe
CHANGED
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,11 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "retypeapp-win-x64",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "2.1.0",
|
|
4
4
|
"description": "Retype CLI.",
|
|
5
5
|
"main": "retype.js",
|
|
6
6
|
"bin": {
|
|
7
7
|
"retype": "retype.js"
|
|
8
8
|
},
|
|
9
|
+
"directories": {
|
|
10
|
+
"bin": "bin"
|
|
11
|
+
},
|
|
9
12
|
"scripts": {
|
|
10
13
|
"test": "echo \"Error: no test specified\" && exit 1"
|
|
11
14
|
},
|