mirrors/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-05-23 11:37:02 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: consolidate docs (#2182)

Browse source 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
This commit is contained in:
Philip Molares 2022-07-21 22:36:46 +02:00 • committed by GitHub
parent 8d46d7e39e
commit ecffebc43c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
307 changed files with 1474 additions and 487 deletions
Download patch file Download diff file Expand all files Collapse all files

5
src/components/landing-layout/navigation/header-bar/header-bar.tsx
View file

@ -1,5 +1,5 @@
/*
* SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
* SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
*
* SPDX-License-Identifier: AGPL-3.0-only
*/
@ -15,6 +15,9 @@ import { SignInButton } from '../sign-in-button'
import { UserDropdown } from '../user-dropdown'
import { cypressId } from '../../../../utils/cypress-attribute'
/**
* Renders a header bar for the intro and history page.
*/
const HeaderBar: React.FC = () => {
useTranslation()
const userExists = useApplicationState((state) => !!state.user)

5
src/components/landing-layout/navigation/new-guest-note-button.tsx
View file

@ -1,5 +1,5 @@
/*
* SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
* SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
*
* SPDX-License-Identifier: AGPL-3.0-only
*/
@ -11,6 +11,9 @@ import { ForkAwesomeIcon } from '../../common/fork-awesome/fork-awesome-icon'
import { cypressId } from '../../../utils/cypress-attribute'
import Link from 'next/link'
/**
* Renders a button to create a new note as a guest.
*/
export const NewGuestNoteButton: React.FC = () => {
const { t } = useTranslation()
return (

5
src/components/landing-layout/navigation/new-user-note-button.tsx
View file

@ -1,5 +1,5 @@
/*
* SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
* SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
*
* SPDX-License-Identifier: AGPL-3.0-only
*/
@ -11,6 +11,9 @@ import { ForkAwesomeIcon } from '../../common/fork-awesome/fork-awesome-icon'
import { cypressId } from '../../../utils/cypress-attribute'
import Link from 'next/link'
/**
* Renders a button to create a new note as a logged in user.
*/
export const NewUserNoteButton: React.FC = () => {
const { t } = useTranslation()
return (

6
src/components/landing-layout/navigation/sign-in-button.tsx
View file

@ -1,5 +1,5 @@
/*
* SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
* SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
*
* SPDX-License-Identifier: AGPL-3.0-only
*/
@ -18,7 +18,9 @@ import { getOneClickProviderMetadata } from '../../login-page/auth/utils/get-one
export type SignInButtonProps = Omit<ButtonProps, 'href'>
/**
* Renders a sign-in button if auth providers are defined. It links to either the login page or if only a single one-click provider is configured, to this one.
* Renders a sign-in button if auth providers are defined.
* It links to either the login page or if only a single one-click provider is configured, to that one.
*
* @param variant The style variant as inferred from the common button component.
* @param props Further props inferred from the common button component.
*/

5
src/components/landing-layout/navigation/user-dropdown.tsx
View file

@ -1,5 +1,5 @@
/*
* SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
* SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
*
* SPDX-License-Identifier: AGPL-3.0-only
*/
@ -14,6 +14,9 @@ import { cypressId } from '../../../utils/cypress-attribute'
import { SignOutDropdownButton } from './sign-out-dropdown-button'
import Link from 'next/link'
/**
* Renders a dropdown menu with user-relevant actions.
*/
export const UserDropdown: React.FC = () => {
useTranslation()
const user = useApplicationState((state) => state.user)