Skip to content

Commit

Permalink
feat: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
aymericzip committed Jun 25, 2024
1 parent 8fd3c1c commit a36156d
Show file tree
Hide file tree
Showing 8 changed files with 97 additions and 6 deletions.
1 change: 1 addition & 0 deletions apps/website/src/Routes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ export enum PagesRoutes {
Doc_ContentDeclaration_Enumeration = '/doc/concept/content_declaration/enumeration',
Doc_ContentDeclaration_FunctionFetching = '/doc/concept/content_declaration/function_fetching',
Doc_ContentDeclaration_NestedId = '/doc/concept/content_declaration/nested_id',
Doc_ContentDeclaration_DeclarationWatching = '/doc/concept/content_declaration/declaration_watching',
Doc_Environment_NextJS = '/doc/environment/intlayer_with_nextjs',
Doc_Environment_CRA = '/doc/environment/intlayer_with_create_react_app',
Doc_Environment_ViteAndReact = '/doc/environment/intlayer_with_vite_and_react',
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
import { type IConfigLocales, getTranslationContent } from 'intlayer';
import type { Metadata } from 'next';
import type { LocalParams } from 'next-intlayer';

export const generateMetadata = ({
params: { locale },
}: LocalParams): Metadata => {
const t = <T>(content: IConfigLocales<T>) =>
getTranslationContent(content, locale);

return {
title: t<string>({
en: 'Intlayer | Declaration file watching',
fr: 'Intlayer | Actualisation des changements des fichiers de déclaration',
es: 'Intlayer | Actualización de los cambios en los archivos de declaración',
}),
description: t({
en: 'Watch your content declaration files for changes and rebuild dictionaries automatically. Follow the steps in this online documentation to set up your project in a few minutes.',
fr: 'Surveillez les fichiers de déclaration de contenu pour les modifications et reconstruisez automatiquement les dictionnaires. Suivez les étapes de cette documentation en ligne pour configurer votre projet en quelques minutes.',
es: 'Monitore sus archivos de declaración de contenido para cambios y reconstruya automáticamente los diccionarios. Siga los pasos de esta documentación en línea para configurar su proyecto en unos minutos.',
}),
keywords: t({
en: [
'Update',
'Content Declaration',
'Internationalization',
'Documentation',
'Intlayer',
'JavaScript',
'React',
],
fr: [
'Mise à jour',
'Déclaration de Contenu',
'Internationalisation',
'Documentation',
'Intlayer',
'JavaScript',
'React',
],
es: [
'Actualización',
'Declaración de Contenido',
'Internacionalización',
'Documentación',
'Intlayer',
'JavaScript',
'React',
],
}),
};
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import { DocPageLayout } from '@components/DocPage/DocPageLayout';
import { DocumentationRender } from '@components/DocPage/DocumentationRender';
import { PageLayout } from '@layouts/PageLayout';
import type { NextPageIntlayer } from 'next-intlayer';
import { generateMetadata } from './metadata';

export { generateMetadata };

const Page: NextPageIntlayer = ({ params: { locale } }) => (
<PageLayout locale={locale} editorEnabled={false}>
<DocPageLayout
activeSections={[
'concept',
'content_declaration',
'declaration_watching',
]}
>
<DocumentationRender docName="content_declaration__declaration_watching" />
</DocPageLayout>
</PageLayout>
);
export default Page;
2 changes: 1 addition & 1 deletion apps/website/src/components/DocPage/DocPageLayout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ export const DocPageLayout: FC<DocPageLayoutProps> = ({
)
}
>
<div className="text-neutral hover:text-text dark:hover:text-text-dark border-neutral dark:border-neutral-dark flex flex-col items-start gap-2 border-l-[0.5px] p-1 transition-colors">
<div className="text-neutral hover:text-text dark:hover:text-text-dark flex flex-col items-start gap-2 border-l-[0.5px] p-1 transition-colors">
{section2.subSections.map((section3) => (
<button
className={cn([
Expand Down
11 changes: 10 additions & 1 deletion apps/website/src/components/DocPage/doc-page.content.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { type DeclarationContent, t, enu } from 'intlayer';
import { PagesRoutes } from '@/Routes';

type NavLink = {
export type NavLink = {
key: string;
title: string;
subSections?: NavLink[];
Expand Down Expand Up @@ -98,6 +98,15 @@ export const navbarContent: DeclarationContent<NavbarContent> = {
}),
url: PagesRoutes.Doc_ContentDeclaration_NestedId,
},
{
key: 'declaration_watching',
title: t({
fr: 'Actualisation des changements',
en: 'Declaration file watching',
es: 'Actualización de los cambios',
}),
url: PagesRoutes.Doc_ContentDeclaration_DeclarationWatching,
},
],
},
{
Expand Down
13 changes: 9 additions & 4 deletions docs/index.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@ const docs = {
fr: require('./docs/intlayer_with_vite+react_fr.md'),
es: require('./docs/intlayer_with_vite+react_es.md'),
},
content_declaration__declaration_watching: {
en: require('./docs/content_declaration/declaration_watching_en.md'),
fr: require('./docs/content_declaration/declaration_watching_fr.md'),
es: require('./docs/content_declaration/declaration_watching_es.md'),
content_declaration__translation: {
en: require('./docs/content_declaration/translation_en.md'),
fr: require('./docs/content_declaration/translation_fr.md'),
es: require('./docs/content_declaration/translation_es.md'),
},
content_declaration__enumeration: {
en: require('./docs/content_declaration/enumeration_en.md'),
Expand All @@ -69,6 +69,11 @@ const docs = {
fr: require('./docs/content_declaration/nested_id_fr.md'),
es: require('./docs/content_declaration/nested_id_es.md'),
},
content_declaration__declaration_watching: {
en: require('./docs/content_declaration/declaration_watching_en.md'),
fr: require('./docs/content_declaration/declaration_watching_fr.md'),
es: require('./docs/content_declaration/declaration_watching_es.md'),
},
};

const getDocs = (lang) =>
Expand Down
1 change: 1 addition & 0 deletions packages/next-intlayer/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ export {
useIntlayer,
useTraduction,
useLocaleCookie,
type IntlayerNode,
} from 'react-intlayer';
export { generateStaticParams } from './generateStaticParams';
export type { LocalParams, NextPageIntlayer } from './types/index';
Expand Down
1 change: 1 addition & 0 deletions packages/react-intlayer/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ export {
getBrowserLocale,
useLocaleBase,
} from './client/index';
export type { IntlayerNode } from './useIntlayerBase';

0 comments on commit a36156d

Please sign in to comment.