MD025 Multiple top level headers in the same document

This commit is contained in:
taitus
2023-03-21 15:55:25 +01:00
parent 1b0246e505
commit d8786fd66a
8 changed files with 23 additions and 15 deletions

View File

@@ -1,7 +1,7 @@
# Customization # Customization
* [Introduction](introduction.md) * [Introduction](introduction.md)
* [Texts & Translations](translations.md) * [Translations & Texts](translations.md)
* [Images](images.md) * [Images](images.md)
* [Views & Styles](views_and_styles.md) * [Views & Styles](views_and_styles.md)
* [Javascript](javascript.md) * [Javascript](javascript.md)

View File

@@ -1,4 +1,6 @@
# Translations # Translations & Texts
## Translations
Currently, CONSUL is totally or partially translated to multiple languages. You can find the translations at the [Crowdin project](https://crowdin.com/project/consul). Currently, CONSUL is totally or partially translated to multiple languages. You can find the translations at the [Crowdin project](https://crowdin.com/project/consul).
@@ -8,7 +10,7 @@ If your language isn't already present in the Crowdin project, please [open an i
If you want to check existing translations of the user-facing texts you can find them organized in YML files under `config/locales/` folder. Take a look at the official Ruby on Rails [internationalization guide](http://guides.rubyonrails.org/i18n.html) to better understand the translations system. If you want to check existing translations of the user-facing texts you can find them organized in YML files under `config/locales/` folder. Take a look at the official Ruby on Rails [internationalization guide](http://guides.rubyonrails.org/i18n.html) to better understand the translations system.
# Custom Texts ## Custom Texts
Since CONSUL is always evolving with new features, and in order to make your fork easier to be updated, we strongly recommend translation files not to be modified, but instead "overwritten" with custom translation files in case a text needs to be customized for you. Since CONSUL is always evolving with new features, and in order to make your fork easier to be updated, we strongly recommend translation files not to be modified, but instead "overwritten" with custom translation files in case a text needs to be customized for you.
@@ -29,7 +31,7 @@ es:
In order to customize it, you should create a new file `config/locales/custom/es/general.yml` with just that content, and change "Ayuntamiento de Madrid" with our organization name. We strongly recommend to make copies from `config/locales/` and modify or delete the lines as needed to keep the indentation structure and avoid issues. In order to customize it, you should create a new file `config/locales/custom/es/general.yml` with just that content, and change "Ayuntamiento de Madrid" with our organization name. We strongly recommend to make copies from `config/locales/` and modify or delete the lines as needed to keep the indentation structure and avoid issues.
# Maintaining your Custom Texts & Languages ## Maintaining your Custom Texts & Languages
CONSUL has the [i18n-tasks](https://github.com/glebm/i18n-tasks) gem, it's an awesome helping tool to manage i18n translations. Just check `i18n-tasks health` for a nice report. CONSUL has the [i18n-tasks](https://github.com/glebm/i18n-tasks) gem, it's an awesome helping tool to manage i18n translations. Just check `i18n-tasks health` for a nice report.

View File

@@ -1,8 +1,10 @@
# Views (HTML) # Views & Styles
## Views (HTML)
If you want to change any page HTML you can just find the correct file under the `app/views` folder and put a copy at `app/views/custom` keeping as well any sub-folder structure, and then apply your customizations. For example if you want to customize `app/views/pages/conditions.html` you'll have to make a copy at `app/views/custom/pages/conditions.html.erb` (note the `pages` subdirectory). If you want to change any page HTML you can just find the correct file under the `app/views` folder and put a copy at `app/views/custom` keeping as well any sub-folder structure, and then apply your customizations. For example if you want to customize `app/views/pages/conditions.html` you'll have to make a copy at `app/views/custom/pages/conditions.html.erb` (note the `pages` subdirectory).
# CSS Styles with SASS ## CSS Styles with SASS
In order to make changes to any CSS selector (custom style sheets), you can add them directly at `app/assets/stylesheets/custom.scss`. For example to change the header color (`.top-links`) you can just add: In order to make changes to any CSS selector (custom style sheets), you can add them directly at `app/assets/stylesheets/custom.scss`. For example to change the header color (`.top-links`) you can just add:

View File

@@ -34,7 +34,7 @@ Reload your virtual machine:
vagrant reload vagrant reload
``` ```
# Running the rails server ## Running the rails server
In your virtual machine, run the application server, binding to your local ip address: In your virtual machine, run the application server, binding to your local ip address:

View File

@@ -1,9 +1,9 @@
# Customization # Customization
* [Introducción](introduction.md) * [Introducción](introduction.md)
* [Textos & Traducciones](translations.md) * [Traducciones y Textos](translations.md)
* [Imágenes](images.md) * [Imágenes](images.md)
* [Vistas & Estilos](views_and_styles.md) * [Vistas y Estilos](views_and_styles.md)
* [Javascript](javascript.md) * [Javascript](javascript.md)
* [Modelos](models.md) * [Modelos](models.md)
* [Componentes](components.md) * [Componentes](components.md)

View File

@@ -1,4 +1,6 @@
# Traducciones # Traducciones y Textos
## Traducciones
Actualmente Consul esta traducido total o parcialmente a multiples idiomas, visita el proyecto en [Crowdin](https://crowdin.com/project/consul) Actualmente Consul esta traducido total o parcialmente a multiples idiomas, visita el proyecto en [Crowdin](https://crowdin.com/project/consul)
@@ -8,7 +10,7 @@ En el caso de que tu lenguage no este presente en el proyecto de Crowdin, por fa
Si quieres ver las traducciones de los textos de la web, puedes encontrarlos en los ficheros formato YML disponibles en `config/locales/`. Puedes leer la [guía de internacionalización](http://guides.rubyonrails.org/i18n.html) de Ruby on Rails sobre como funciona este sistema. Si quieres ver las traducciones de los textos de la web, puedes encontrarlos en los ficheros formato YML disponibles en `config/locales/`. Puedes leer la [guía de internacionalización](http://guides.rubyonrails.org/i18n.html) de Ruby on Rails sobre como funciona este sistema.
# Textos personalizados ## Textos personalizados
Dado que CONSUL está en evolución continua con nuevas funcionalidades, y para que mantener tu fork actualizado sea más sencillo, recomendamos no modificar los ficheros de traducciones, es una mejor idea "sobreescribirlos" usando ficheros personalizados en caso de necesidad de alterar un texto. Dado que CONSUL está en evolución continua con nuevas funcionalidades, y para que mantener tu fork actualizado sea más sencillo, recomendamos no modificar los ficheros de traducciones, es una mejor idea "sobreescribirlos" usando ficheros personalizados en caso de necesidad de alterar un texto.
@@ -30,7 +32,7 @@ es:
Si creamos el fichero `config/locales/custom/es/general.yml` y modificamos "Ayuntamiento de Madrid" por el nombre de la organización que se este haciendo la modificación. Recomendamos directamente copiar los ficheros `config/locales/` e ir revisando y corrigiendo las que querramos, borrando las líneas que no querramos traducir. Si creamos el fichero `config/locales/custom/es/general.yml` y modificamos "Ayuntamiento de Madrid" por el nombre de la organización que se este haciendo la modificación. Recomendamos directamente copiar los ficheros `config/locales/` e ir revisando y corrigiendo las que querramos, borrando las líneas que no querramos traducir.
# Mantener tus Textos Personalizados y Lenguajes ## Mantener tus Textos Personalizados y Lenguajes
CONSUL tiene la gema [i18n-tasks](https://github.com/glebm/i18n-tasks), es una herramienta estupenda para gestionar textos i18n. Prueba en tu consola `i18n-tasks health` para ver un reporte de estado. CONSUL tiene la gema [i18n-tasks](https://github.com/glebm/i18n-tasks), es una herramienta estupenda para gestionar textos i18n. Prueba en tu consola `i18n-tasks health` para ver un reporte de estado.

View File

@@ -1,8 +1,10 @@
# Vistas (HTML) # Vistas y Estilos
## Vistas (HTML)
Si quieres modificar el HTML de alguna página puedes hacerlo copiando el HTML de `app/views` y poniendolo en `app/views/custom` respetando los subdirectorios que encuentres ahí. Por ejemplo si quieres modificar `app/views/pages/conditions.html` debes copiarlo y modificarla en `app/views/custom/pages/conditions.html.erb` Si quieres modificar el HTML de alguna página puedes hacerlo copiando el HTML de `app/views` y poniendolo en `app/views/custom` respetando los subdirectorios que encuentres ahí. Por ejemplo si quieres modificar `app/views/pages/conditions.html` debes copiarlo y modificarla en `app/views/custom/pages/conditions.html.erb`
# Estilos CSS con SASS ## Estilos CSS con SASS
Si quieres cambiar algun selector CSS (de las hojas de estilo) puedes hacerlo en el fichero `app/assets/stylesheets/custom.scss`. Por ejemplo si quieres cambiar el color del header (`.top-links`) puedes hacerlo agregando: Si quieres cambiar algun selector CSS (de las hojas de estilo) puedes hacerlo en el fichero `app/assets/stylesheets/custom.scss`. Por ejemplo si quieres cambiar el color del header (`.top-links`) puedes hacerlo agregando:

View File

@@ -34,7 +34,7 @@ Recargue la máquina virtual:
vagrant reload vagrant reload
``` ```
# Ejecutar el servidor ## Ejecutar el servidor
En su máquina virtual, debe ejecutar la aplicación enlanzándola a su IP local: En su máquina virtual, debe ejecutar la aplicación enlanzándola a su IP local: