kovah / linkace-website Goto Github PK

View Code? Open in Web Editor NEW

10.0 3.0 8.0 7.62 MB

The source of the LinkAce website and documentation.

Home Page: https://www.linkace.org/

HTML 81.47% JavaScript 3.69% SCSS 14.84%

documentation linkace hugo

linkace-website's Introduction

LinkAce Website and Documentation

This is the source of the LinkAce website and documentation.

Contribution & Development

The website is built using Hugo. Please make sure you have it installed locally. Additionally, you need Node v16. Styling is done via Bootstrap and code blocks use Prism.js.

# Install dependencies
npm install

# Build all assets
npm run dev

# Serve the website locally
npm run serve

I may decline contributions for large content or style changes. Make sure to talk to me before starting to work. Spelling and grammar corrections are always welcome.

LinkAce is a project by Kevin Woblick and Contributors

linkace-website's People

Contributors

Stargazers

Watchers

Forkers

sinkaszab jiangzhuolin jeffmatson rastacalavera chrissawyerfan4 mjaschen sergiorgiraldo anan-es

linkace-website's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

chore(deps): update dependency sass to v1.69.4
fix(deps): update dependency algoliasearch to v4.20.0
fix(deps): update dependency instantsearch.js to v4.58.0
fix(deps): update npm (major) (bootstrap, sass-loader)
Click on this checkbox to rebase all open PRs at once

Detected dependencies

npm

package.json

algoliasearch ^4.12.1

bootstrap ^4.6.1

instantsearch.js ^4.38.1

prismjs ^1.25.0

atomic-algolia ^0.3.19

cross-env ^7.0.3

laravel-mix ^6.0.39

sass ^1.44.0

sass-loader ^8.0.2

Extend documentation about notes

"Setup with SQLite" doesn't contain hint to set "SETUP_COMPLETED=true" in .env file

See Kovah/LinkAce#340

Links to files missing

In your Docker installation guide you mention files that is required, but there is no hyperlink to the files or where to download them.

Move the sidebar from the right to the left

Improvement Documentation

Hi Kevin

I struggled a bit setting up LinkAce, finding the documentation not always up to date or consistent.

If you are open to it, I could help a bit to improve it, amd make it easier for other to get LinkAce up and running?

Got the Hugo site already running locally inside a devcontainer; so I'm ready to go!

Discourage usage of SQLite

Discourage usage of SQLite because of ongoing issues with the installation prowess and usage with LinkAce.

Improve documentation

Two suggestions to improve your documentation

Please add the following line to the chapter 'Running Linkace behind a proxy / load balancer'
for Nginx configuration example:
proxy_set_header Host $host;
This line is neccessary to generate URLs correctly
Please add the following line to the chapter 'Setup with Docker -> 2. Modify the files"
Please make sure the .env is readable and writable for 'others' (-rw-rw-rw- or 666)

No apache htaccess provided

I cannot find any .htaccess file inside the linkace root folder, where is it?