Skip to content

Commit

Permalink
updating the markdown files
Browse files Browse the repository at this point in the history
  • Loading branch information
tnylea committed May 27, 2024
1 parent 3798c57 commit a560d8d
Show file tree
Hide file tree
Showing 18 changed files with 175 additions and 108 deletions.
Binary file modified assets/images/screens/confirm.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/screens/login.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/screens/password-reset-request.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/screens/password-reset.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/screens/register.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/screens/two-factor.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/screens/verify.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 23 additions & 0 deletions assets/js/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ document.addEventListener("DOMContentLoaded", function() {
createRadialBackgrounds();
updateTOC();
addHeadingsToTOC();
renderSmoothAnchorLinks();
window.dispatchEvent(new CustomEvent('set-route', { detail: { route: window.location.href } }));
});

Expand Down Expand Up @@ -295,6 +296,7 @@ document.addEventListener('htmx:afterSettle', function(evt) {
setTimeout(function(){
updateTOC();
addHeadingsToTOC();
renderSmoothAnchorLinks();
}, 10);
});

Expand All @@ -321,6 +323,27 @@ window.addHeadingsToTOC = function(){
});
}

window.renderSmoothAnchorLinks = function(){
const smoothScrollLinks = document.querySelectorAll('.smooth-scroll');

smoothScrollLinks.forEach(link => {
link.addEventListener('click', (event) => {
event.preventDefault();
const targetId = link.getAttribute('href').substring(1);
const offset = 20; // Adjust the offset value as per your requirement
const targetElement = document.getElementById(targetId);

if (targetElement) {
const targetPosition = targetElement.getBoundingClientRect().top + window.pageYOffset;
window.scrollTo({
top: targetPosition - offset,
behavior: 'smooth'
});
}
});
});
}

window.renderTocFunctionality = function(){
const tocALinks = document.querySelectorAll('.toc li a');

Expand Down
61 changes: 54 additions & 7 deletions content/docs/authentication-pages.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,63 @@
---
title: Authentication Pages
description: The features provided by DevDojo Auth
prevTitle: 'Installation'
prevURL: '/docs/install'
prevSlug: 'install'
slug: 'authentication-pages'
nextTitle: 'Setup & Customizations'
nextURL: '/docs/setup-customizations'
nextSlug: 'setup-customizations'
authenticationPages: true
---

DevDojo Auth contains the features necessary for most common authentication functionality. Below is a general overview of the functionality provided.
DevDojo Auth contains many pages that provide common authentication functionality. Below is a preview and overview of all the available authentication pages.

## Login
## Registration

The Login Page. Visit this page at **/auth/login**

<include src="docs/auth-page-image.html" page="login"></include><div class="p-5 rounded-b-lg border text-zinc-300 bg-zinc-900 border-zinc-700">
The login page is where a user can enter their email address and password and be authenticated in your application. You may optionally choose to show social provider links on this page.
</div>

## Register

The Register Page. Visit this page at **/auth/register**

<include src="docs/auth-page-image.html" page="register"></include><div class="p-5 rounded-b-lg border text-zinc-300 bg-zinc-900 border-zinc-700">The registration page is where a user can sign up for a new account. Additionally, you can require users to provide their full name and allow them so register from any <a href="{ url('/docs/config/social-providers') }">Social Provider</a>.
</div>

## Verify Email
## Forgot Password
## Confirm Password
## Social Login
## Two-Factor Authentication
## Authentication Setup

The Email Verification Page. Visit this page at **/auth/verify**

<include src="docs/auth-page-image.html" page="verify"></include><div class="p-5 rounded-b-lg border text-zinc-300 bg-zinc-900 border-zinc-700">By default users are not required to verify their email. Toggle the <strong>Registration Require Email Verification</strong> option in the settings to show this screen after account creation.</div>

## Password Confirmation

The Password Confirmation Page. Visit this page at **/auth/confirm**

<include src="docs/auth-page-image.html" page="confirm"></include><div class="p-5 rounded-b-lg border text-zinc-300 bg-zinc-900 border-zinc-700">Add the <strong>password.confirm</strong> middleware to any page, and users will be required to confirm their password before gaining access to the page.</div>

## Password Reset Request

The Password Reset Request Page. Visit this page at **/auth/password/reset**

<include src="docs/auth-page-image.html" page="password-reset-request"></include><div class="p-5 rounded-b-lg border text-zinc-300 bg-zinc-900 border-zinc-700">When the user clicks the <strong>Forgot Password</strong> link, this is the page they will see, allowing them to <strong>Request</strong> a Password Reset.</div>

## Password Reset

The Password Reset Page. Visit this page at **/auth/password/ReAlLyLoNgToKeNhErE**

<include src="docs/auth-page-image.html" page="password-reset"></include><div class="p-5 rounded-b-lg border text-zinc-300 bg-zinc-900 border-zinc-700">This is the actual password reset page. When the user clicks a link from their email to reset their password, this is the page they will see, allowing them to reset their password.</div>

## Two-Factor Challenge

The Password Confirmation Page. Visit this page at **/auth/two-factor-challenge**

<include src="docs/auth-page-image.html" page="two-factor"></include><div class="p-5 rounded-b-lg border text-zinc-300 bg-zinc-900 border-zinc-700">If you are using 2FA and the user has enabled 2FA for their account, this is the page they will see after attempting to log in. Learn more about <a href="{ url('/docs/config/two-factor-auth') }">Two-Factor Authentication here</a>.</div>

---

Next, lets dive into customizations and confiruations you can add to your authentication pages.
7 changes: 7 additions & 0 deletions content/docs/config/social-providers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Social Providers
description: Allow users to authenticate with many Social Providers
---

Add Info Here...

4 changes: 2 additions & 2 deletions content/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ DevDojo Auth is an open-source <a href="https://packagist.org/packages/devdojo/a

## Quick Start

To get started install the package, then visit `/auth/setup` to customize and modify your authentication.
After [installation](/docs/install), visit **/auth/setup** to customize and modify your authentication.

<img src="https://devdojo.com/platform/auth/assets/images/setup-screen.jpg" class="w-full h-auto rounded-md" />

After installing you'll be able to visit all the available Authentication pages in your application.
After DevDojo Auth is installed you'll be able to visit these [Authentication Pages](/docs/authentication-pages) in your application.

## Why use it?

Expand Down
16 changes: 0 additions & 16 deletions content/docs/index.md

This file was deleted.

8 changes: 8 additions & 0 deletions content/docs/setup-customizations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Setup and Customizations
description: Learn about the Authentication Setup and Customization page
setup: true
---

DevDojo Auth comes with a simple Setup page to help you customize and configure your authentication.

Loading

0 comments on commit a560d8d

Please sign in to comment.