-
Notifications
You must be signed in to change notification settings - Fork 446
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: Trimming README.md to send to Raneto Docs
- Loading branch information
Showing
20 changed files
with
165 additions
and
100 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
Credits | ||
------- | ||
|
||
- Raneto was created by [Gilbert Pellegrom](https://gilbitron.me) | ||
- Maintained by [Ryan Lelek](https://www.ryanlelek.com) from [AnsibleTutorials.com](https://www.ansibletutorials.com) | ||
- Logo by [@mmamrila](https://github.com/mmamrila) | ||
- Released under the [MIT license](https://github.com/ryanlelek/Raneto/blob/main/LICENSE) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
Title: Related Projects | ||
Sort: 9 | ||
--- | ||
|
||
This list contains additional projects that will help you deploy and run Raneto. | ||
|
||
# Themes | ||
- [Default Theme](https://github.com/raneto/theme-default) | ||
|
||
# Deployment | ||
- [Deploy Raneto to your servers with Ansible](https://github.com/ryanlelek/raneto-devops) by [@ryanlelek](https://github.com/ryanlelek) | ||
- [Run Raneto in a Vagrant container](https://github.com/draptik/vagrant-raneto) by [@draptik](https://github.com/draptik) | ||
- [Deploy Raneto using Docker container](https://github.com/appsecco/raneto-docker) by [@madhuakula](https://github.com/madhuakula) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
Title: Roadmap | ||
Sort: 9 | ||
--- | ||
|
||
# Raneto Roadmap | ||
- Join the [Roadmap Discussion](https://github.com/ryanlelek/Raneto/issues/374) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
6 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
Title: Containers | ||
Sort: 8 | ||
--- | ||
|
||
# Containers (Docker) | ||
|
||
Official Raneto container images on [Docker Hub](https://hub.docker.com/r/raneto/raneto/tags) | ||
|
||
Run the default container, and access on [localhost:3000](http://localhost:3000) | ||
`docker run --rm -it --publish 3000:3000 raneto/raneto:latest` | ||
|
||
Same as above, but provide your own content and configuration | ||
``` | ||
docker run --rm -it --publish 3000:3000 \ | ||
--volume \ | ||
--volume \ | ||
raneto/raneto:latest | ||
``` | ||
|
||
Want to poke around the files in the container? Get a shell: | ||
`docker run --rm -it --publish 3000:3000 --volume raneto/raneto:latest /bin/sh` |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
Title: Default Password | ||
Sort: 8 | ||
--- | ||
|
||
# Default Password | ||
Make sure you edit the default username and password in your `config.js` file. | ||
``` | ||
##### WARNING ##### | ||
// You MUST change the username and password for security | ||
// Do NOT use "admin" as a username as it's easily guessed. | ||
// You are encouraged to use tools to generate a password | ||
// Preferably, use a local password manager | ||
// If you absolutely must use an online tool, here are some suggestions | ||
// https://bitwarden.com/password-generator/ | ||
// https://www.grc.com/passwords.htm | ||
``` |
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
Title: Getting Started | ||
Sort: 2 | ||
ShowOnHome: true | ||
ShowOnMenu: true | ||
--- | ||
|
||
# Markdown Reference | ||
If you want to embed links and images, you'll need to use the Markdown syntax. | ||
[See this Markdown Guide](https://www.markdownguide.org/cheat-sheet) | ||
|
||
# Essentials | ||
Visit the [Example Repo](https://github.com/raneto/example) | ||
See the [installation guide](https://docs.raneto.com/install/installing-raneto) for more information. | ||
|
||
# Links | ||
- [Configuration](https://docs.raneto.com/usage/configuration) | ||
- [Production Notes](https://docs.raneto.com/install/production-notes) | ||
- [Deploying to Heroku](https://docs.raneto.com/tutorials/deploying-raneto-to-heroku) | ||
- [Contributing](https://github.com/ryanlelek/Raneto/blob/main/CONTRIBUTE.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
Title: News | ||
Sort: 3 | ||
ShowOnHome: true | ||
ShowOnMenu: true | ||
--- | ||
|
||
# Raneto News | ||
|
||
## April 30th 2024 | ||
### Changes | ||
- v0.18.x is bringing big updates to modernize Raneto | ||
- Separated theme + Raneto for easier customization | ||
- Dependency upgrades across the board | ||
### Upcoming | ||
- Slimming down the project. After 10+ years, some packages are either no longer needed or not maintained | ||
- Official support for containers (Docker, Podman) | ||
- Complete revisit of the documentation |
This file was deleted.
Oops, something went wrong.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
5 | ||
3 |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
Title: Highlight Node.js Code Title | ||
Sort: 2 | ||
--- | ||
|
||
# Introduction | ||
You can highlight code by using the HTML pattern in your Markdown like this: | ||
``` | ||
<pre><code> | ||
Code goes here... | ||
</code></pre> | ||
``` | ||
You language should be detected automatically but it's better to be explicit. | ||
``` | ||
<pre><code class="language-javascript"> | ||
Code goes here... | ||
</code></pre> | ||
``` | ||
The list of languages is on this [highlight.js documentation page](https://highlightjs.readthedocs.io/en/latest/supported-languages.html) | ||
|
||
## Node.js Code | ||
<pre><code class="language-javascript">let value = 'variable'; | ||
const OK = true; | ||
function fn() { | ||
console.log("Works"); | ||
} | ||
</code></pre> | ||
|
||
## SQL Code | ||
<pre><code class="language-sql">CREATE TABLE "topic" ( | ||
"id" integer NOT NULL PRIMARY KEY, | ||
"forum_id" integer NOT NULL, | ||
"subject" varchar(255) NOT NULL | ||
); | ||
ALTER TABLE "topic" | ||
ADD CONSTRAINT forum_id FOREIGN KEY ("forum_id") | ||
REFERENCES "forum" ("id"); | ||
|
||
-- Initials | ||
insert into "topic" ("forum_id", "subject") | ||
values (2, 'D''artagnian'); | ||
</code></pre> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters